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/partners/conceptual-model.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Apps represent a unit of functionality that Segment users can add to their works
30
30
- Within Destinations, we have Streaming Destinations, Batch Destinations, and Warehouse Destinations, all of which receive different data, using different processes, at different intervals and with varying degrees of control and flexibility.
31
31
- On the Sources side, integrations are categorized based on whether they send Objects or Events, whether they are "Push" or "Pull," and whether they are built and hosted by Segment or by Partners.
32
32
33
-

33
+

34
34
35
35
These smaller pieces that support the source and destination model are called "Components".

22
22
23
23
> warning ""
24
24
> Segment working on an OAuth solution to reduce friction for customers. Partner Streams submitted through the developer center *will* be required to support this OAuth as it comes available.
Copy file name to clipboardExpand all lines: src/partners/subscriptions/build-functions.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Review the steps outlined in the [Developer Center Overview](/docs/partners). Th
27
27
28
28
Begin by selecting the _Subscription_ card in your Developer Center UI after creating an App and selecting _I want Segment to run functions I write_. Next, you will see the code editor where you can take full control of your Subscriptions's logic. Segment provides boilerplate functions that make it simple to send data to your API Endpoint. You can delete the example code and implement your own functions.

31
31
32
32
For every event you send to Segment, Segment invokes a function you provide for the event type. So you must define functions named after every type in the [Segment Spec](/docs/connections/spec/) that you support:
33
33
@@ -186,7 +186,7 @@ When testing your integration, proceed through two separate flows:
186
186
187
187
Test your code directly from the Developer Center UI. Use the `Send Test Event` button and review the test event to make sure your function works as expected.

190
190
191
191
In the debugger panel, check the two outputs. The **Callback Return** and the **Log Output**.
192
192
@@ -195,7 +195,7 @@ In the debugger panel, check the two outputs. The **Callback Return** and the **
195
195
196
196
When your code is working with one event you can test it with a suite of more Segment events. Click `Save and Next: Test`, fill in an `API Key` and click `Test`. You will see the results of additional types of Segment data.

199
199
200
200
### The User Flow
201
201
@@ -211,7 +211,7 @@ Now you can use the JavaScript SDK in a browser to generate real analytics event
211
211
212
212
Finally you should verify the data in your service.
213
213
214
-

214
+

Copy file name to clipboardExpand all lines: src/partners/subscriptions/build-webhook.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ See the [headers](#headers) section for more details.
51
51
#### Custom Settings
52
52
All subscriptions have an API key setting by default, which Segment will send in the Authorization Header. To add more custom settings, go to the `Settings Builder` page under `App Info`.

55
55
56
56
Any custom settings you add will be sent in the custom header `X-Segment-Settings` (See the [headers](#headers) section for more details.)
57
57
@@ -159,7 +159,7 @@ When testing your integration, proceed through two separate flows:
159
159
160
160
Test your code directly from the Developer Center UI. Use the `Send Test Event` button and review the test event to make sure your function works as expected.

163
163
164
164
In the debugger panel, check the two outputs. The **Callback Return** and the **Log Output**.
165
165
@@ -168,7 +168,7 @@ In the debugger panel, check the two outputs. The **Callback Return** and the **
168
168
169
169
When your code is working with one event you can test it with a suite of more Segment events. Click `Save and Next: Test`, fill in an `API Key` and click `Test`. You will see the results of additional types of Segment data.

172
172
173
173
### The User Flow
174
174
@@ -184,7 +184,7 @@ Now you can use the JavaScript SDK in a browser to generate real analytics event
184
184
185
185
Finally you should verify the data in your service.
186
186
187
-

187
+

Copy file name to clipboardExpand all lines: src/privacy/portal.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ You can click a row in the Inbox to learn more about a field and where it was co
35
35
- an example code snippet containing a payload that the field appears in
36
36
37
37
38
-

38
+

39
39
40
40
41
41
To streamline the classification process, Segment pre-classifies the data in the
@@ -56,7 +56,7 @@ dropdown menu to change. For example, you might manually change a field that
56
56
does not contain personal information in your implementation from a "Yellow"
57
57
classification to "Green."
58
58
59
-

59
+

60
60
61
61
62
62
When you're satisfied that the fields have been classified appropriately, you
@@ -86,7 +86,7 @@ The Inventory is a central repository of all of the properties _you_ classified
86
86
87
87
Once you've classified the fields as Red, Yellow, and Green in the Inbox, the classified fields appear in the Inventory. You can use the filter at the top left to filter down to specific categories of data (for example, Red data, data from a production environment, data from specific sources).
88
88
89
-

89
+

90
90
91
91
Click into a field (for example, `ip`) in the Inventory to open the Inventory
92
92
details. The details sheet displays how many times a specific field has been
@@ -100,7 +100,7 @@ connected to the Source that contains the field. The Access tab displays a list
100
100
of who within your organization has access to this field.
101
101
102
102
103
-

103
+

104
104
105
105
106
106
Finally, workspace owners can use the **Download CSV** button to export a CSV of
@@ -207,10 +207,10 @@ treat that property whenever it is appears in data Segment processes.
207
207
-**Similar to** matches a **Key** that is similar to a term within a fuzzy string distance (for example "email" and "e-mail"). We built fuzzy matching using [this public GitHub repository](https://github.com/imjasonmiller/godice). If the score is > 0.7, then we say it's a match.
208
208
209
209
210
-

210
+

211
211
212
212
213
-

213
+

214
214
215
215
216
216
Unless the field value pattern is unique, we recommend matching on the Key. For
Copy file name to clipboardExpand all lines: src/protocols/apis-and-extensions/anomaly_detection.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Regardless of the solution you choose, we recommend that you create a new Segmen
29
29
30
30
Next, set up [Violation forwarding](/docs/protocols/validate/forward-violations/) for each Tracking Plan connected to the Source. Once connected, your sources will look like:
31
31
32
-

32
+

33
33
34
34
**Note: When you enable violation forwarding, it counts as 1 MTU toward your monthly MTU limit. If you are on an API plan, all forwarded violations count against your API limit. Violations might also generate costs in downstream destinations and data warehouses.**
35
35
@@ -49,13 +49,13 @@ Source: {% raw %}`{{properties.sourceName}}` \nEvent: `{{properties.eventName}}`
49
49
```
50
50
When you're done, it'll look like the screenshot below.
51
51
52
-

52
+

53
53
54
54
55
55
### Create customized Anomaly Detection dashboards in a BI tool
56
56
Custom dashboards are a great way to focus your teams around the metrics and events that matter most to your business. With a few simple queries you can build a dashboard to share with teams, so everyone can understand how well they're doing against your data quality objectives. Here's an example dashboard that combines [forwarded Violations](/docs/protocols/validate/forward-violations/) with production event data to track data quality. See below for detailed SQL queries!
57
57
58
-

58
+

59
59
60
60
Note: For all queries below, replace `protocols_audit_source` with whatever schema name you set for your forwarded violations source.
Copy file name to clipboardExpand all lines: src/protocols/starter.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,13 +25,13 @@ You can add the Tracking Plan Read Only role to workspace members, or to groups
25
25
To see your Tracking Plan, click **Protocols** in the left navigation. The first time you visit this section, the Segment App shows an explanation of tracking plans, which you can dismiss. Click **Create Tracking Plan** to get started.
26
26
27
27
28
-

28
+

29
29
30
30
31
31
From the screen that appears, click **Add Events** to add your first event to the tracking plan.
32
32
33
33
34
-

34
+

35
35
36
36
37
37
@@ -45,15 +45,15 @@ On the next page, you'll select the events that you need from the Segment Standa
45
45
3. Click **Next** to review properties on the events.
46
46
47
47
48
-

48
+

49
49
50
50
51
51
52
52
The next screen shows the Events you chose and their properties. Properties are how you enrich the raw event data with useful context, which allows you to perform useful analysis and alerting. These standard events have a minimum set of properties based on what we know about the event type, and how it is usually used. You can add extra custom properties in the next step.
53
53
54
54
Expand each event to view its properties. If you decide you want to add or remove Events, click **Previous** to go back to the event list. When you're satisfied that you've selected Standard Events for all of the activities on your site, click **Add**.
55
55
56
-

56
+

57
57
58
58
59
59
@@ -65,15 +65,15 @@ You might want to add extra properties to the Segment standard events, for examp
65
65
66
66
To add a custom property, click the **plus** icon next to the event that the property should be attached to.
67
67
68
-

68
+

69
69
70
70
71
71
In the dialog that appears, enter the name and type of the property, and add a description.
72
72
73
73
You can click **Save and add more** to add more than one property, or click **Save and exit** when you're satisfied that you've added all the properties you'll need.
74
74
75
75
76
-

76
+

77
77
78
78
79
79
@@ -83,7 +83,7 @@ The Tracking Plan page shows an overview of the data that is arriving to your Se
83
83
84
84
You can click each event in the table to expand it, view the event description, and view its properties and their descriptions. Property descriptions include the expected data type for each property.
85
85
86
-

86
+

87
87
88
88
The **Sending** column shows the number of Events Segment has seen with that description and format. You can expand this to see how many of the events Segment saw for Dev, Test, and Production sources. If you see a 0 in this column for all sources, this usually means that the event has not been implemented yet, or has not been implemented correctly.
Copy file name to clipboardExpand all lines: src/protocols/tracking-plan/libraries.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ To create a new Library:
19
19
2. Click **Libraries** in the top navigation bar
20
20
3. Click **New Library** and follow the steps to create an event or property library
21
21
22
-

22
+

23
23
24
24
### Tracking Plan Event Libraries
25
25
@@ -33,7 +33,7 @@ Tracking Plan property Libraries support Track event property groups. Property L
33
33
34
34
You can import event and property libraries into a Tracking Plan. Enter the Draft mode for a Tracking Plan and click the **Import from Event or Property Library** dropdown. A wizard will appear allowing you to either add the events to a tracking plan, or add properties to selected events already in the tracking plan. After adding your events or properties, remember to merge your changes!

37
37
38
38
### Library syncing
39
39
@@ -47,5 +47,5 @@ Syncing a Library makes events and properties un-editable, and bypasses the Trac
47
47
> warning ""
48
48
> All changes made to a synced library pass through to the Tracking Plans and may impact data deliverability
49
49
50
-

50
+

With your Tracking Plan is complete, it's time to apply the Tracking Plan to one or more Sources. Select **Connect Source** from the right hand menu for your specific Tracking Plan.

12
12
13
13
14
14
From this menu, you will be redirected to a workflow to select a Source from your workspace. Note that a Source can only have one tracking plan applied to it. You *can't* select a Source that already has a Tracking Plan connected to it, but you *can* apply a Tracking Plan to multiple sources.
@@ -17,10 +17,10 @@ After selecting a Source, you will be shown the consequences of connecting your
17
17
18
18
**IMPORTANT: Make sure to read through the consequences of connecting a source!**

21
21
22
22
## Disconnect Source from Tracking Plan
23
23
24
24
To disconnect the Source from the Tracking Plan, go to the Tracking Plan overview page, locate the column for the tracking plan you want to disconnect, then click the icon under the **Connected Sources**. In the settings that appear, click **Disconnect** next to the Source you want to disconnect.
25
25
26
-

26
+

0 commit comments