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/sources/catalog/libraries/server/http-api/index.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,16 @@ To send data to Segment's HTTP API, a content-type header must be set to `'appli
24
24
25
25
## Errors
26
26
27
-
Segment returns a `200` response for all API requests so debugging should be done in the Segment Debugger. The only exception is if the request is too large / JSON is invalid it will respond with a `400`.
27
+
Segment returns a `200` response for all API requests except errors caused by large payloads and JSON errors (which return `400` responses.) To debug events that return `200` responses but aren't accepted by Segment, use the Segment Debugger.
28
28
29
-
Segment welcomes feedback on API responses and error messages. [Reach out to support](https://segment.com/help/contact/) with any requests or suggestions you may have.
29
+
Common reasons events are not accepted by Segment include:
30
+
-**Payload is too large:** The HTTP API can handle API requests that are 32KB or smaller. The batch API endpoint accepts a maximum of 500KB per request, with a limit of 32KB per event in the batch. If these limits are exceeded, Segment returns a 400 Bad Request error.
31
+
-**Identifier is not present**: The HTTP API requires that each payload has a userId and/or anonymousId.
32
+
-**Track event is missing name**: All `track` events sent to Segment must have an `event` field.
33
+
-**Deduplication**: Segment deduplicates events using the `messageId` field, which is automatically added to all payloads coming into Segment. If you're setting up the HTTP API yourself, ensure all events have unique messageId values.
34
+
-**Invalid JSON**: If you send an event with invalid JSON, Segment returns a 400 Bad Request error.
35
+
36
+
Segment welcomes feedback on API responses and error messages. [Reach out to support](https://segment.com/help/contact/){:target="_blank"} with any requests or suggestions you may have.
Copy file name to clipboardExpand all lines: src/privacy/user-deletion-and-suppression.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,3 +97,17 @@ Refer to [List Suppressions](https://docs.segmentapis.com/tag/Deletion-and-Suppr
97
97
### List Deletion Requests for your Workspace
98
98
99
99
Refer to the [List Regulations from Source](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listRegulationsFromSource){:target="_blank"} Public API method.
100
+
101
+
## Data retention
102
+
103
+
Set lifecycle policies for the data stored internally in Segment’s secure event Archives, on S3.
104
+
105
+
These limits represent the amount of time that Segment stores a copy of event data received by any of your sources. Segment recommends keeping at least 30 days of data to enable [Replays](/docs/guides/what-is-replay/) of your data.
106
+
107
+
### Workspace Default Archive Retention Period
108
+
109
+
Select the default retention period for the workspace here. This value applies to all sources in the workspace, unless overridden.
110
+
111
+
### Source-Level Archive Retention Periods
112
+
113
+
Override the workspace default retention period on a per-source level.
Copy file name to clipboardExpand all lines: src/profiles/identity-resolution/identity-resolution-settings.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,3 +190,4 @@ When choosing the priority of your identifier, ask the following questions about
190
190
1. Is it an immutable ID? Give immutable IDs, such as user_id, highest priority.
191
191
2. Are they unique IDs? Give Unique IDs such as email higher priority than possibly shared identifiers like android.id or ios.id.
192
192
3. Does it temporarily identify a user? Identifiers such as anonymous_id, ios.idfa, and ga_client_id are constantly updated or expired for a user. Generally speaking, rank these lower than identifiers that permanently identify a user.
For information about Profiles Identity Resolution Settings, see [Identity Resolution Settings](/docs/profiles/identity-resolution/identity-resolution-settings/)
8
+
9
+
## Sources
10
+
11
+
Sources provide the data that Profiles uses to perform Identity Resolution. You can add multiple sources to a single Profiles space. Profiles supports the following Source types:
Copy file name to clipboardExpand all lines: src/segment-app/iam/audit-trail.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Audit Trail
3
3
---
4
4
{% include content/plan-grid.md name="audit-trail" %}
5
5
6
-
Segment offers an in-app 90 day Audit Trail for Business Tier accounts. If you are a workspace Owner, you view user and system activity in your workspace settings, in the "Audit Trail" tab under "Admin".
6
+
Segment offers an in-app 90 day Audit Trail for Business Tier accounts. If you are a Workspace Owner, you view user and system activity in your workspace settings, in the "Audit Trail" tab under "Admin".
7
7
8
8
You can filter for specific actions or actors to see who made changes on specific resources in the app. Actors can include both logged-in users as well as access tokens. You can export the information to a CSV for download, or forward the activity to a Segment source. For example, you can forward audit trail activity to set up real-time Slack alerts and quickly revert changes that could cause unwanted downstream effects, such as a user unintentionally disabling a warehouse.
9
9
@@ -89,3 +89,16 @@ The Audit Trail includes information on the following activity:
89
89
* Engage Warehouse Source Created
90
90
* Engage Warehouse Source Modified
91
91
* Engage Warehouse Source Deleted
92
+
93
+
94
+
## Audit forwarding
95
+
96
+
You can forward events in your workspace to any of the sources you have configured in the workspace.
97
+
98
+
To forward Audit Trail events:
99
+
100
+
1. Navigate to **Settings > Workspace Settings > Audit Forwarding**.
101
+
2. Select the source to which you'll forward workspace events.
102
+
3. Toggle the setting to **On** and click **Save Changes**.
103
+
104
+
When you forward audit events to a source, Segment passes those events through its entire processing pipeline. This ensures that tracking plans, filters, and other features work with the audit events, and also ensures you can send those events to multiple downstream destinations.
Copy file name to clipboardExpand all lines: src/segment-app/support-access.md
+6-14Lines changed: 6 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,19 @@
1
1
---
2
-
title: Granting Segment Support Access
3
-
hidden: true
2
+
title: Support Access
4
3
---
5
-
You can contact Segment Product Support by [submitting a ticket](https://segment.com/help/contact/).
4
+
To best assist you after you submit a support ticket, Segment's Customer Success Engineers may request temporary access to your workspace. Once you grant access to your workspace, CSEs can access your workspace for up to 7 days, or until you revoke access.
6
5
7
-
If you submit a particularly tricky ticket to our Segment Support Engineers, we might ask you to grant temporary access to your Segment account so we can troubleshoot your issue. Once granted access, a Segment Support Engineer can access your account for up to 7 days. You can also revoke Support Access at any time. This option is always available to you, but you only need to grant access when it is recommended by a Segment Support Engineer.
8
-
> note ""
9
-
> *Note*: Support Access is not available for workspaces using forced-SSO at this time.
6
+
> info ""
7
+
> Support Access is not available for workspaces using forced-SSO at this time.
10
8
11
9
## Granting a Segment Support Engineer access to your account
12
-
Support Access is available for all Segment Workspace Owners and can be found under your [Workspace Settings](https://app.segment.com/goto-my-workspace/settings/support-access).
10
+
Support Access is available for all Segment Workspace Owners and can be found on the **Support Access** tab of the [Workspace Settings](https://app.segment.com/goto-my-workspace/settings/support-access) page.
13
11
14
12
Click **Grant Access** to allow a Segment Support Engineer to access your account.
15
13
16
-
When Segment Support no longer needs access to your account, simply revoke access at any time.
17
14
18
-

19
-
_The Segment Settings page before granting Support Access_
15
+
## Support privileges
20
16
21
-

22
-
_The Segment Settings page after granting Support Access_
23
-
24
-
**What can a Segment Support Engineer do in my account?**
25
17
When you grant Support Access, the Segment Support Engineers can do everything that you can do in your workspace.
Copy file name to clipboardExpand all lines: src/segment-app/workspace-home.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,10 @@
2
2
title: Workspace Home
3
3
---
4
4
5
-
{% include content/plan-grid.md name="workspace-home" %}
6
-
7
-
8
5
Segment's Workspace Home serves as a dashboard that gives you a single consolidated view of the workspace, its health and status, and metrics for specific integrations over time.
9
6
10
-
> info ""
11
-
> The Workspace Home is available only to Business tier customers, and is only visible for [Workspace Owners](/docs/segment-app/iam/roles/). If you have access to the Home page, it is the first screen you see when you first log in to your Segment Workspace.
7
+
> info "Availability"
8
+
> The Workspace Home is visible to users who have the Workspace Owner [role](/docs/segment-app/iam/roles/). If you have access to the Home page, it is the first screen you see when you log in to your Segment Workspace.
12
9
13
10
The Home page shows a summary of errors in the workspace's sources and destinations, a list of "favorite" integrations that you can configure, and information about recent audit logged events, and your billing plan usage.
14
11
@@ -29,6 +26,10 @@ If your Segment plan includes Protocols, the dashboard shows [Event Violations](
If your Segment plan does not include Protocols, an Events Received chart is shown to reflect the number of events received across sources.
32
+
32
33
## Destinations - Event Delivery
33
34
34
35
The Destinations section of the Home page shows a summary of the Event Delivery for the workspace, including a graph over time. You can click the **destinations** link to see a list of destinations with delivery problems, ordered from highest to lowest error rate. You can click a destination to see more details about the delivery failures, and from the details panel click the destination name to go directly to its configuration page.
@@ -50,7 +51,7 @@ To delete a favorite, click the **more** (…) menu and select **Remove favorite
50
51
51
52
## Recent Activity
52
53
53
-
The recent activity section displays the most recent items logged to the Segment Audit trail. This includes workspace membership changes and requests, changes to the configuration of different Segment features (including sources, destinations, and to Engage and Protocols configurations), and data storage sync failures.
54
+
For users with Business Tier workspaces, the recent activity section displays the most recent items logged to the Segment Audit trail. This includes workspace membership changes and requests, changes to the configuration of different Segment features (including sources, destinations, and to Engage and Protocols configurations), and data storage sync failures.
0 commit comments