You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/spec/signals.md
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,19 @@
2
2
title: 'Spec: Signals'
3
3
---
4
4
5
-
This page is a guide for developers who want to track events with Segment's Auto-Instrumentation. It explains structure and definition of Signals.
6
-
5
+
This is a guide for developers who want to track events with Segment's Auto-Instrumentation. It explains the structure and definitions of Signals.
7
6
8
7
## Overview
9
8
10
-
Signals provides automated user activity tracking through a sophisticated breadcrumb system. It captures crucial user interactions and allows you to transform them into meaningful analytics events using JavaScript.
9
+
Signals provide automated user activity tracking through a sophisticated breadcrumb system. They capture crucial user interactions and allows you to transform them into meaningful analytics events using JavaScript.
10
+
11
+
### Key features
11
12
12
-
### Key Features
13
+
The key features of signals include:
13
14
14
15
-**Comprehensive Activity Tracking**
15
16
- User interface interactions
16
-
- Network activity monitoring (inbound/outbound)
17
+
- Network activity monitoring (inbound and outbound)
17
18
- Local data access patterns
18
19
- Integration with existing analytics events
19
20
-**Enterprise-Grade Privacy**
@@ -25,18 +26,18 @@ Signals provides automated user activity tracking through a sophisticated breadc
25
26
- Create custom event generation rules
26
27
- Process and filter data in real-time
27
28
28
-
## Signal Types
29
+
## Signal types
29
30
30
31
There are 6 different types of Signals:
31
32
32
-
-**Interaction Signal** - Captures user interactions with interface elements such as clicks, form submissions, and input changes
33
-
-**Navigation Signal** - Tracks navigation events and screen/page transitions in web and mobile applications
34
-
-**Network Signal** - Monitors HTTP requests and responses, including API calls and data fetching operations
35
-
-**Local Data Signal** - Records local data storage operations like creating, reading, updating, or deleting data
36
-
-**Instrumentation Signal** - Captures existing analytics events and instrumentation data from Segment Analytics
37
-
-**User Defined Signal** - Allows for custom signal types with application-specific data and properties
33
+
-**Interaction Signal** - Captures user interactions with interface elements such as clicks, form submissions, and input changes.
34
+
-**Navigation Signal** - Tracks navigation events and [Screen](/docs/connections/spec/screen) or [Page](/docs/connections/spec/page) transitions in web and mobile applications.
35
+
-**Network Signal** - Monitors HTTP requests and responses, including API calls and data fetching operations.
36
+
-**Local Data Signal** - Records local data storage operations like creating, reading, updating, or deleting data.
37
+
-**Instrumentation Signal** - Captures existing analytics events and instrumentation data from Segment Analytics.
38
+
-**User-defined Signal** - Allows for custom signal types with application-specific data and properties.
38
39
39
-
### Base Signal Properties
40
+
### Base signal properties
40
41
41
42
All signals include these base properties:
42
43
@@ -61,9 +62,9 @@ All signals include these base properties:
61
62
}
62
63
```
63
64
64
-
#### Content Properties
65
+
#### Content properties
65
66
66
-
The `Context` type is defined as follow:
67
+
The `Context` type is defined as follows:
67
68
68
69
| Property | Type | Description |
69
70
|----------|------|-------------|
@@ -92,7 +93,6 @@ The `Context` type is defined as follow:
92
93
}
93
94
```
94
95
95
-
96
96
#### Web-Specific Properties
97
97
98
98
Web signals include additional page context:
@@ -122,10 +122,10 @@ Web signals include additional page context:
122
122
}
123
123
```
124
124
125
-
### Specific Signal Properties
126
-
#### Interaction Signals
125
+
### Specific signal properties
126
+
#### Interaction signals
127
127
128
-
Capture user interactions with interface elements.
128
+
Interaction signals capture user interactions with interface elements.
129
129
130
130
##### Web
131
131
@@ -175,9 +175,9 @@ Capture user interactions with interface elements.
175
175
}
176
176
```
177
177
178
-
#### Navigation Signals
178
+
#### Navigation signals
179
179
180
-
Track navigation and screen changes.
180
+
Navigation signals track navigation and screen changes.
181
181
182
182
##### Web
183
183
@@ -217,9 +217,9 @@ Track navigation and screen changes.
217
217
}
218
218
```
219
219
220
-
#### Network Signals
220
+
#### Network signals
221
221
222
-
Monitor network requests and responses.
222
+
Network signals monitor network requests and responses.
223
223
224
224
| Property | Type | Description |
225
225
|----------|------|-------------|
@@ -244,7 +244,7 @@ Monitor network requests and responses.
244
244
}
245
245
```
246
246
247
-
#### Local Data Signals
247
+
#### Local data signals
248
248
249
249
Track local data storage operations.
250
250
@@ -263,9 +263,9 @@ Track local data storage operations.
263
263
}
264
264
```
265
265
266
-
#### Instrumentation Signals
266
+
#### Instrumentation signals
267
267
268
-
Capture analytics events and instrumentation data.
268
+
Instrumentation signals capture analytics events and instrumentation data.
269
269
270
270
| Property | Type | Description |
271
271
|----------|------|-------------|
@@ -288,9 +288,9 @@ Capture analytics events and instrumentation data.
288
288
}
289
289
```
290
290
291
-
#### User Defined Signals
291
+
#### User-defined signals
292
292
293
-
Allow for custom signal types with arbitrary data.
293
+
User-defined signals allow for custom signal types with arbitrary data.
294
294
295
295
| Property | Type | Description |
296
296
|----------|------|-------------|
@@ -305,4 +305,4 @@ Allow for custom signal types with arbitrary data.
0 commit comments