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/delivery-overview.md
+3-8Lines changed: 3 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,6 @@ title: Delivery Overview
4
4
5
5
Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any cloud-streaming destination receiving events from cloud-streaming sources.
6
6
7
-
> info "Delivery Overview for RETL destinations and Engage Audience Syncs currently in development"
8
-
> This means that Segment is actively developing Delivery Overview features for RETL destinations and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available.
9
-
>
10
-
> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations) and in public beta for storage destinations. Some metrics specific to storage destinations, like selective syncs, failed row counts, and total rows seen, are not yet available.
11
-
> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations.
12
-
13
-
14
7
## Key features
15
8
16
9
Delivery Overview has three core features:
@@ -65,13 +58,15 @@ The following image shows a storage destination with 23 partially successful syn
65
58
66
59
#### Destinations connected to Audiences
67
60
Destinations connected to an Audience have the following steps in the pipeline view:
68
-
-**Events from audience**: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
61
+
-**Events from audience**<sup>*</sup>: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
69
62
-**Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/).
70
63
-**Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step.
71
64
-**Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table.
72
65
-**Failed delivery**: Events that Segment _attempted_ to deliver to your destination, but that ultimately _failed_ to be delivered. Failed delivery might indicate an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery.
73
66
-**Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
74
67
68
+
<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._
69
+
75
70
### Breakdown table
76
71
The breakdown table provides you with greater detail about the selected events.
Copy file name to clipboardExpand all lines: src/engage/audiences/index.md
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -217,8 +217,9 @@ Delivery Overview has three core features:
217
217
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.
218
218
219
219
To view Delivery Overview for an Audience:
220
-
1. From your Segment workspace's home page, navigate to **Connections > Destinations**.
221
-
2. Select the Destination connected to your Audience and select the Delivery Overview tab.
220
+
To filter by events:
221
+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
222
+
2. Find an Audience, click the **(...)** menu, and select Delivery Overview.
222
223
3. On the Delivery Overview page, select the Audience dropdown to filter by a specific Audience, select the Date range dropdown to filter by a specific time period, or toggle the Show metrics as percentages toggle on to view your metrics as percentages.
223
224
224
225
#### Steps in the pipeline view
@@ -228,16 +229,18 @@ By default, Segment displays Delivery Overview information for all Audiences con
228
229
You can also further refine the data displayed on the pipeline view using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you’d like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, _85% of events_ or _an 133% increase in events_) or as counts (_13 events_ or _an increase of 145 events_.) Delivery Overview shows percentages by default.
229
230
230
231
> info "Linked Audiences have additional filtering functionality"
231
-
> Linked Audiences users can also filter the Delivery Overview event pipeline by [event emitters](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). For more information, see the [Linked Audiences](/docs/engage/audiences/linked-audiences/#delivery-overview-for-linked-audiences) documentation.
232
+
> Linked Audiences users can filter the Delivery Overview event pipeline by [Linked Audience events](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). For more information, see the [Linked Audiences](/docs/engage/audiences/linked-audiences/#delivery-overview-for-linked-audiences) documentation.
232
233
233
234
Audiences have the following steps in the pipeline view:
234
-
-**Events from audience**: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
235
+
-**Events from audience**<sup>*</sup>: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
235
236
-**Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/).
236
237
-**Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step.
237
238
-**Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table.
238
239
-**Failed delivery**: Events that Segment _attempted_ to deliver to your destination, but that ultimately _failed_ to be delivered. Failed delivery might indicate an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery.
239
240
-**Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
240
241
242
+
<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._
243
+
241
244
### Alerting
242
245
243
246
Create alerts related to the performance and throughput of Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur.
0 commit comments