Skip to content

Commit 69c0393

Browse files
committed
complete first draft
1 parent ba72fb1 commit 69c0393

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

src/connections/delivery-overview.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,15 @@ The following image shows a storage destination with 23 partially successful syn
6363

6464
![A screenshot of the Delivery Overview tab for a Storage destination, with the Failed to sync step selected and a table of partially successful syncs.](images/delivery-overview-storage-destinations.png)
6565

66+
#### Destinations connected to Audiences
67+
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.
69+
- **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+
- **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+
- **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+
- **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+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
74+
6675
### Breakdown table
6776
The breakdown table provides you with greater detail about the selected events.
6877

src/engage/audiences/index.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -203,35 +203,39 @@ Engage then processes your realtime Audience or Trait edits. While the edit task
203203
204204
## Monitor the health of your Audience syncs
205205

206-
Use Segment's [Delivery Overview](#delivery-overview) and [Alerting](#alerting) features to monitor the health of your Audience syncs and get notified when event volume spikes or drops.
206+
Use Segment's [Delivery Overview](#delivery-overview) and [Alerting](#alerting) features to monitor the health of your Audience syncs and get notifications when event volume spikes or drops.
207207

208208
### Delivery Overview
209209

210210
Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any event-streaming destination receiving events from Engage Audiences.
211211

212212
Delivery Overview has three core features:
213-
- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process - from your source recieving audience events all the way to events successfully delivered to your connected destination.
214-
- [Breakdown table](#breakdown-table): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step.
215-
- [Discard table](#discard-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them.
213+
- [Pipeline view](/docs/connections/delivery-overview/#pipeline-view): A visual overview of each step your data takes during the delivery process - from when your source receives audience events to when events are successfully delivered to your connected destination.
214+
- [Breakdown table](/docs/connections/delivery-overview/#breakdown-table): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step.
215+
- [Discard table](/docs/connections/delivery-overview/#discard-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them.
216216

217-
You can refine these tables 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 *a 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default.
217+
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.
218218

219-
For more information about the pipeline view, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.
220-
221-
> info "Linked Audiences have additional filtering functionality"
222-
> 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.
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.
222+
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.
223223

224224
#### Steps in the pipeline view
225225

226-
Audiences have the following steps in the pipeline view:
226+
By default, Segment displays Delivery Overview information for all Audiences connected to your destination. You can filter your Delivery Overview pipeline view by an individual Audience for more granular data.
227227

228-
Delivery Overview shows you four steps in your data activation pipeline:
228+
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.
229229

230+
> 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+
233+
Audiences have the following steps in the pipeline view:
230234
- **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.
231-
- **Filtered at source**:
235+
- **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/).
232236
- **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.
233-
- **Events pending retry**: A step that reveals the number of events that are awaiting retry.
234-
- **Failed delivery**: Events that Segment attempted to deliver to your destination, but ultimately failed to deliver to your destination. Failed delivery indicates an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery.
237+
- **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+
- **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.
235239
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
236240

237241
### Alerting

0 commit comments

Comments
 (0)