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/destinations/catalog/mixpanel/index.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,13 +47,18 @@ If you want to track the `page` or `screen` calls to Mixpanel with the name or c
47
47
> info ""
48
48
> Beginning with "Consolidate Page" calls, the following options are each *mutually exclusive*. [See the code for details](https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/mixpanel/lib/index.js#L96-L139){:target="_blank"}.
49
49
50
+
### Prioritization of settings
50
51
52
+
When you use the Mixpanel destination in Cloud-mode, Segment sends events for each option you select. This may result in Mixpanel receiving duplicate events for a single page call.
51
53
52
-
If you select "Track all Pages to Mixpanel", all `page` calls regardless of how you have customized it will send a `Loaded A Page`. Even if you have the other options enabled, Segment sends this call to prevent double counting your pageviews.
54
+
When you use the Mixpanel destination in Device-mode, Segment prioritizes the options to prevent duplicate calls as follows:
53
55
54
-
If you select "Track Categorized Pages to Mixpanel", Segment sends a `Viewed [category] Page` event.
55
56
56
-
If you select "Track Named Pages to Mixpanel", Segment sends a `Viewed [name] Page` event.
57
+
- If you select "Track all Pages to Mixpanel", all `page` calls regardless of how you have customized it will send a `Loaded A Page`. Even if you have the other options enabled, Segment sends this call to prevent double counting your pageviews.
58
+
59
+
- If you select "Track Categorized Pages to Mixpanel", Segment sends a `Viewed [category] Page` event.
60
+
61
+
- If you select "Track Named Pages to Mixpanel", Segment sends a `Viewed [name] Page` event.
57
62
58
63
> info ""
59
64
> If both Option 2 and 3 are enabled, Segment gives precedence to `category`. If you pass both `category` and `name`, (for example, `analytics.page('category', 'name');`), Segment sends a `Viewed category name Page` to Mixpanel.
@@ -339,9 +344,6 @@ Segment doesn't map `$library_version` since that is reserved for Mixpanel's lib
339
344
340
345
## Features
341
346
342
-
### Autotrack
343
-
344
-
Mixpanel discontinued the Autotrack feature in February 2021. The feature is no longer available for use.
345
347
346
348
### People
347
349
@@ -584,7 +586,7 @@ You can check a specific user profile in Mixpanel for Computed Traits by going t
584
586
585
587
Computed traits without a lookback window search across all historical events, and update in real time.
586
588
587
-
Computed traits with a lookback window only search across events that occurred within the specified timeframe. Computed traits *with* a lookback window are updated hourly.
589
+
Computed traits with a lookback window only search across events that occurred within the specified time frame. Computed traits *with* a lookback window are updated hourly.
588
590
589
591

590
592
@@ -624,7 +626,7 @@ You can check a specific user profile in Mixpanel for audience events by going t
624
626
625
627
Audiences without a lookback window searches across all historical events and update in real time.
626
628
627
-
Audiences with a lookback window only search across events that occurred within the specified timeframe. Audiences *with* a lookback window are updated hourly.
629
+
Audiences with a lookback window only search across events that occurred within the specified time frame. Audiences *with* a lookback window are updated hourly.
Copy file name to clipboardExpand all lines: src/connections/event-delivery.md
+24-21Lines changed: 24 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,16 +6,16 @@ The Event Delivery tool helps you understand if data is reaching your destinatio
6
6
7
7
Segment sends billions of events to destinations every week. If Segment encounters any errors when attempting to deliver your data, Segment reports them in the Event Delivery tool.
8
8
9
-
Here is an example of what the Event Delivery tool looks like:
9
+
Here's an example of what the Event Delivery tool looks like:
-**When data seems to be missing in your destination.**
18
-
For example, you have Google Analytics set up as a destination and your recent data looks incomplete
18
+
For example, you have Google Analytics set up as a destination and your recent data looks incomplete.
19
19
-**When setting up a destination for the first time.**
20
20
For example, you are connecting Google Analytics to your Node Source. Once you've entered your credentials and turned the destination on, you can use this feature to see whether events are successfully making it to GA in near realtime.
21
21
@@ -27,32 +27,32 @@ Scenarios when this tool will be useful:
27
27
This feature is only available for server side integrations (also known as cloud-mode destinations). You will not be able to use this for client side / device-mode destinations as device-mode data is sent directly to the tool's API. To be report on deliverability, the data must be sent to Destinations using Segment's APIs.
28
28
29
29
> warning ""
30
-
> **Not available for Warehouses or Amazon S3**. These destinations work differently to our other destinations, and aren't supported at this time.
30
+
> **Not available for Warehouses or Amazon S3**. These destinations work differently from other destinations in Segment, and aren't supported at this time.
31
31
32
32
33
33
## Where do I find it?
34
34
35
35
Event Delivery can be accessed within any supported destination in the App. It's located on the tab under "Settings" for each destination.
36
36
37
-

37
+

38
38
39
39
40
40
## How do I use Event Delivery?
41
41
42
-
The UI consists of 3 key parts that report on Segment's ability to deliver your source data - Key Metrics, Error Details and Delivery Trends. Reporting on core functionality from top to bottom:
42
+
The UI consists of three key parts that report on Segment's ability to deliver your source data - Key Metrics, Error Details, and Delivery Trends. Reporting on core functionality from top to bottom:
43
43
44
44
## 1. Time period
45
45
46
46
47
-
There is a drop down menu to select your time period. All of the UI is updated based on the time period you select.
47
+
There's a drop down menu to select your time period. All of the UI is updated based on the time period you select.
48
48
49
-

49
+

50
50
51
51
## 2. Key Metrics
52
52
53
53
From left to right in the above graphic:
54
54
55
-
-**Delivered:** This tells you the number of messages Segment successfully delivered to a destination in the time period you selected
55
+
-**Delivered:** This tells you the number of messages Segment successfully delivered to a destination in the time period you selected.
56
56
57
57
-**Not Delivered:** This count tells you the number of messages Segment was unable to deliver. If this number is higher than zero, you will see the reasons for this failure in the errors table below.
58
58
@@ -63,45 +63,48 @@ From left to right in the above graphic:
63
63
64
64
The purpose of the table is to provide you a summary of the different errors we've seen in a given period and the most important information on them. All of the rows in the table are clickable and expand to give you more information.
> View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
67
70
68
71
### Error detail view
69
72
70
-
When we see an error, we want to give you as much information to help you solve your problem. See below for an example of what this view looks like.
73
+
When there's an error, Segment wants to give you as much information as possible to help you resolve the issue. See below for an example of what this view looks like.
71
74
72
-

75
+

73
76
74
77
This view includes:
75
78
76
79
#### Description
77
80
78
-
The event delivery UI provides a human-friendly summary of the error, based on the payload we received back from the partner
81
+
The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
79
82
80
83
#### Actions
81
84
82
-
These are actions we think you can take to solve the issue, based on what we know about the issue.
85
+
These are actions you can take, based on what Segment knows about the issue.
83
86
84
87
#### More Info
85
88
86
-
Links to any documentation that we think could be helpful to you
89
+
This section displays links to any documentation that might be helpful to you.
87
90
88
91
89
92
#### Sample payloads
90
93
91
-
To help you debug we provide sample payloads from every step of the data's journey through Segment
94
+
To help you debug, Segment provides sample payloads from every step of the data's journey:
92
95
93
-
-**You Sent** - the data you sent to Segment's API
96
+
-**You Sent** - the data you sent to Segment's API.
94
97
95
-
-**Request to Destination** - the request we made to the Partner API. This payload will likely be different from what you sent it because Segment is mapping your event to the partner's spec to ensure the message is successfully delivered.
98
+
-**Request to Destination** - the request Segment made to the Partner API. This payload will likely be different from what you sent it because Segment is mapping your event to the partner's spec to ensure the message is successfully delivered.
96
99
97
-
-**Response from Destination** - the response we received from the Partner API. This will have the raw partner error. If you need to troubleshoot an issue with a Partner's Success team, this is usually something they'll want to see.
100
+
-**Response from Destination** - the response Segment received from the Partner API. This will have the raw partner error. If you need to troubleshoot an issue with a Partner's Success team, this is usually something they'll want to see.
98
101
99
102
100
103
## 4. Trends
101
104
102
-
When debugging, it's helpful to see when issues start, stop and trend over time.
105
+
When debugging, it's helpful to see when issues start, stop, and trend over time.
Copy file name to clipboardExpand all lines: src/connections/functions/destination-functions.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ All functions are scoped to your workspace, so members of other workspaces can't
17
17
18
18
19
19
> note ""
20
-
> Destination functions does not accept data from [Object Cloud sources](/docs/connections/sources/#object-cloud-sources).
20
+
> Destination functions doesn't accept data from [Object Cloud sources](/docs/connections/sources/#object-cloud-sources).
21
21
22
22
## Create a destination function
23
23
@@ -35,9 +35,9 @@ When you click **Build**, a code editor appears. Use the editor to write the cod
35
35
Segment invokes a separate part of the function (called a "handler") for each event type that you send to your destination function.
36
36
37
37
> info ""
38
-
> Your function is not invoked for an event if you've configured a [destination filter](/docs/connections/destinations/destination-filters/), and the event doesn't pass the filter.
38
+
> Your function isn't invoked for an event if you've configured a [destination filter](/docs/connections/destinations/destination-filters/), and the event doesn't pass the filter.
39
39
40
-
The default source code template includes handlers for all event types. You do not need to implement all of them - just use the ones you need, and skip the ones you don't.
40
+
The default source code template includes handlers for all event types. You don't need to implement all of them - just use the ones you need, and skip the ones you don't.
41
41
42
42
Destination functions can define handlers for each message type in the [Segment spec](/docs/connections/spec/):
43
43
@@ -129,7 +129,7 @@ async function onTrack(event) {
129
129
}
130
130
131
131
```
132
-
If you do not supply a function for an event type, Segment throws an `EventNotSupported` error by default.
132
+
If you don't supply a function for an event type, Segment throws an `EventNotSupported` error by default.
133
133
134
134
You can read more about [error handling](#destination-functions-logs-and-errors) below.
135
135
@@ -271,15 +271,15 @@ async function onIdentifyBatch(events, settings) {
271
271
272
272
### Configure your batch parameters
273
273
274
-
By default, Functions waits up to 10 seconds to form a batch of 20 events. You can increase the number of events included in each batch (up to 400 events per batch) by contacting [Segment support](https://segment.com/help/contact/){:target="_blank"}. Segment recommends users who wish to include fewer than 20 events per batch use destination functions without the `onBatch` handler.
274
+
By default, Functions waits up to 10 seconds to form a batch of 20 events. You can increase the number of events included in each batch (up to 400 events per batch) by contacting [Segment support](https://segment.com/help/contact/){:target="_blank"}. Segment recommends users who wish to include fewer than 20 events per batch use destination functions without the `onBatch` handler.
275
275
276
276
### Test the batch handler
277
277
278
-
The [Functions editing environment](/docs/connections/functions/environment/) supports testing batch handlers.
278
+
The [Functions editing environment](/docs/connections/functions/environment/) supports testing batch handlers.
279
279
280
-
To test the batch handler:
281
-
1. In the right panel of the Functions editor, click **customize the event yourself** to enter Manual Mode.
282
-
2. Add events as a JSON array, with one event per element.
280
+
To test the batch handler:
281
+
1. In the right panel of the Functions editor, click **customize the event yourself** to enter Manual Mode.
282
+
2. Add events as a JSON array, with one event per element.
283
283
3. Click **Run** to preview the batch handler with the specified events.
284
284
285
285
> note ""
@@ -291,7 +291,7 @@ The [Config API](/docs/config-api/) Functions/Preview endpoint also supports tes
291
291
292
292
### Handling batching errors
293
293
294
-
Standard [function error types](/docs/connections/functions/destination-functions/#destination-functions-error-types) apply to batch handlers. Segment attempts to retry the batch in the case of Timeout or Retry errors. For all other error types, Segment discards the batch. It is also possible to report a partial failure by returning status of each event in the batch. Segment retries only the failed events in a batch until those events are successful or until they result in a permanent error.
294
+
Standard [function error types](/docs/connections/functions/destination-functions/#destination-functions-error-types) apply to batch handlers. Segment attempts to retry the batch in the case of Timeout or Retry errors. For all other error types, Segment discards the batch. It's also possible to report a partial failure by returning status of each event in the batch. Segment retries only the failed events in a batch until those events are successful or until they result in a permanent error.
295
295
296
296
```json
297
297
[
@@ -357,6 +357,8 @@ A function can throw errors, or Segment might encounter errors while invoking yo
357
357
358
358
Segment only attempts to send the event to your destination function again if a **Retry** error occurs.
359
359
360
+
You can view Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
361
+
360
362
### Destination functions logs
361
363
362
364
If your function throws an error, execution halts immediately. Segment captures the event, any outgoing requests/responses, any logs the function might have printed, as well as the error itself.
@@ -470,6 +472,6 @@ The [Event Delivery tab](/docs/connections/event-delivery/) continues to show me
470
472
471
473
##### How does batching impact function use and cost?
472
474
473
-
A function's use depends on the number of times it is invoked, and the amount of time it takes to execute. When you enable batching, Segment invokes your function _once per batch_ rather than once per event. The volume of events flowing through the function determines the number of batches, which determines the number of invocations.
475
+
A function's use depends on the number of times it's invoked, and the amount of time it takes to execute. When you enable batching, Segment invokes your function _once per batch_ rather than once per event. The volume of events flowing through the function determines the number of batches, which determines the number of invocations.
474
476
475
477
If you're sending your batch to an external service, the execution time of the function depends on the end-to-end latency of that service's batch endpoint, which may be higher than an endpoint that receives a single event.
Copy file name to clipboardExpand all lines: src/connections/integration_error_codes.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
@@ -13,4 +13,4 @@ id: integrationerrors
13
13
| errors.awaiting-retry.429 | Rate limit exceeded. contact the partner to raise your limit or avoid sending events in burst. |
14
14
| errors.awaiting-retry.5xx | The partner's API report an internal error. Consider disabling this integration or contact the integration partner to address this issue. |
15
15
| errors.awaiting-retry.ENOTFOUND<br>errors.awaiting-retry.ECONNREFUSED <br>errors.awaiting-retry.ECONNRESET<br>errors.awaiting-retry.ECONNABORTED<br>errors.awaiting-retry.EHOSTUNREACH<br>errors.awaiting-retry.EAI_AGAIN | Segment is unable to establish a connection with the partner's server. This could mean your Segment configurations contain some invalid settings or that the integration is no longer operational. If your configurations are valid, consider disabling this integration or contact the integration partner to address this issue. |
16
-
| Others | Refer to the error message you receive for more information. Refer to our <ahref="/docs/connections/test-connections/"> How do I test my connections guide</a> for more debugging help.
16
+
| Others | Refer to the error message you receive for more information. See the article, [Testing Connections](/docs/connections/test-connections/)for more debugging help.
0 commit comments