Skip to content

Commit 0ff9b06

Browse files
authored
Merge pull request #5674 from segmentio/master-to-develop
Master back to develop
2 parents b8f336d + c1b39f6 commit 0ff9b06

File tree

6 files changed

+100
-9
lines changed

6 files changed

+100
-9
lines changed

src/_data/sidenav/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,8 @@ sections:
356356
title: Profile API
357357
- path: /unify/debugger
358358
title: Profile Debugger
359+
- path: /unify/insights
360+
title: Profiles Insights
359361
- path: /unify/unify-gdpr
360362
title: Unify and GDPR
361363
- path: /unify/faqs

src/unify/identity-resolution/identity-resolution-onboarding.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@ redirect_from:
55
- "/personas/identity-resolution/identity-resolution-onboarding"
66
---
77

8-
> note ""
9-
> **NOTE:** The steps in this guide pertain to spaces created after **October 5th, 2020**. For spaces created before **October 5th, 2020**, please refer to [Identity Resolution Settings](/docs/unify/identity-resolution/identity-resolution-settings).
8+
> info ""
9+
> The steps in this guide pertain to spaces created after **October 5th, 2020**. For spaces created before **October 5th, 2020**, please refer to [Identity Resolution Settings](/docs/unify/identity-resolution/identity-resolution-settings).
1010
11-
> note ""
12-
> **NOTE:** Workspace owners, administrators, and users with the Identity Admin role can edit Identity Resolution Settings.
11+
> success ""
12+
> Workspace owners, administrators, and users with the Identity Admin role can edit Identity Resolution Settings.
1313
1414
Segment creates and merges user profiles based on a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId`, and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the Profile explorer.
1515

16-
> success ""
17-
> Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.
16+
Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.
1817

1918
![Identities tab of a profile in the Profile explorer](images/jane_doe_new_identities.png)
2019

src/unify/identity-resolution/identity-resolution-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ redirect_from:
99

1010

1111

12-
> note ""
12+
> info ""
1313
> The steps in this guide pertain to spaces created before September 27th, 2020. For spaces created after September 27th, 2020, please refer to the onboarding guide [here](/docs/unify/identity-resolution/identity-resolution-onboarding/).
1414
1515
## Configure Identity Graph rules

src/unify/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@ redirect_from:
77

88
Use Segment Unify, formerly known as Profiles, for a complete view of your customers.
99

10-
With [Identity Resolution](#identity-resolution), track every interaction across the entire user journey to create unified, real-time customer identities. View user profiles in one place through the [Profile explorer](#profile-explorer) in the Segment app. Use the [Profile API](#profile-api) to programmatically query user profiles, traits, and events.
10+
With [Identity Resolution](#identity-resolution), track every interaction across the entire user journey to create unified, real-time customer identities. View user profiles in one place through the [Profile explorer](#profile-explorer) in the Segment app. Use the [Profile API](#profile-api) to programmatically query user profiles, traits, and events.
1111

1212
You can then use this interaction data with customer engagement tools, such as Engage, to deliver personalized, omnichannel experiences.
1313

14+
> success ""
15+
> If you need to troubleshoot or learn about your profile data, use [Profiles Insights](/docs/unify/insights/) for a transparent view of your Unify profiles.
16+
17+
1418
## Getting started
1519

1620
> info ""
@@ -64,6 +68,14 @@ Use the Profile API to help your organization:
6468

6569
Visit Segment's [Profile API doc](/docs/unify/profile-api/) for more information.
6670

71+
## Profiles Insights
72+
73+
Use Profiles Insights to troubleshoot your event data with a transparent view of your Unify profiles.
74+
75+
Learn about your events and identifiers on your profiles and answer questions such as why two profiles didn't merge, why an event wasn't resolved to a profile, or why an external ID isn't present.
76+
77+
Visit the [Profiles Insights](/docs/unify/insights/) doc to learn more.
78+
6779
## Next steps: activate your profiles with Engage
6880

6981
For Engage users, after you set up your identity rules and have data flowing through Unify, you can activate profiles to deliver personalized engagement experiences. Visit the [Engage docs](/docs/engage/) to learn more.

src/unify/insights.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: Profiles Insights
3+
plan: unify
4+
---
5+
6+
With Profiles Insights, you can troubleshoot event data with transparent insight into your [Unify profiles](/docs/unify/). View errors and violations, success logs, and an audit trail for events that flow into your profiles. You can also learn why certain issues occur, and take preventative action against future errors.
7+
8+
## Getting started
9+
10+
To get started with Profiles Insights, navigate to **Unify** > **Profiles insights**.
11+
12+
From the Profiles Insights page, you can navigate to these tabs:
13+
- [Errors and violations](#errors-and-violations)
14+
- [Success logs](#success-logs)
15+
- [Audit trail](#audit-trail)
16+
17+
## Errors and violations
18+
19+
Use the errors and violations tab to view and help you troubleshoot any errors or violations that have occurred in your space.
20+
21+
You can filter results by ID type, time range, specific violations, and more.
22+
23+
### Errors
24+
25+
Errors occur when a message didn't resolve to a profile because Segment didn't find a matching identifier or the system behaved unexpectedly. Click on an error log to view the error and next steps that Segment recommends.
26+
27+
Profiles Insights flags the following error:
28+
29+
| Error | Description |
30+
|---------------|-----------------------------------------------|
31+
| `No matching identifiers on event` | The event didn't have any identifier types that matched your [ID Resolution Settings](/docs/unify/identity-resolution/identity-resolution-settings). As a result, the event didn't resolve to a profile. |
32+
33+
> warning ""
34+
> Profile Insights won't surface errors if the event was dropped before entering Unify's [Identity Resolution](/docs/unify/identity-resolution/). Learn more about [Unify ingestion limits](/docs/unify/product-limits/#unify-ingestion-limitations).
35+
36+
### Violations
37+
38+
Violations occur when incoming events don't comply with your [Identity Resolution Settings](/docs/unify/identity-resolution/identity-resolution-settings). For example, when Segment drops an anonymous ID (lower priority) to resolve an event based on a matching user ID (higher priority), it results in a violation.
39+
40+
> success ""
41+
> [Learn about identifier priorities](/docs/unify/identity-resolution/identity-resolution-settings/#priority) in your Identity Resolution.
42+
43+
For any violations, Segment may drop lower priority identifiers or the identifiers that violate your Identity Resolution Settings. From the grid, you can click a log name to view the violation details and recommended next steps.
44+
45+
You can use the **Message Payload** tab to view raw messages for Track events and see exactly where the violation occurred.
46+
47+
Profiles Insights flags the following violations:
48+
49+
| Violation | Description |
50+
|---------------|-----------------------------------------------|
51+
| `Identifier value limit exceeded` | A lower priority identifier wasn't added to the associated profile(s) because the maximum number of values for the identifier type exceeds the limit. |
52+
| `Identifier value time limit exceeded` | A lower priority identifier wasn't added to the associated profile(s) because there's a limit to how many identifier type values can be added in a period of time. |
53+
| `ID value blocked` | The identifier wasn't added to a profile because it's a blocked value. |
54+
| `Profile merge limit exceeded` | The profile exceeds the system imposed merge limit. Segment's default limit is 100. |
55+
| `Identifier mapping limit exceeded` | The profile exceeds the system imposed mapping limit. Segment's default limit is 1,000. |
56+
| `Identifier value set to unique (legacy)` | The profile exceeds the cardinality limit of an identifier type set to be unique. This violation only appears for existing spaces that have the `enforce_unique` field configured. |
57+
| `Identifier value limit exceeded (legacy)` | The profile exceeds the cardinality limit of an identifier type. The cardinality limit used for this violation is the `limit` field in the identifier space. |
58+
59+
## Success logs
60+
61+
Success logs provide visibility into a profile's journey from creation to the point of merging into other profiles.
62+
63+
Use the success logs to view:
64+
- Profiles that Segment has merged
65+
- Identifiers that Segment has mapped to a profile
66+
67+
You can filter results by ID type, time range, incoming event type, and more.
68+
69+
When you click a specific log, Segment displays merge or mapping details along with the message payload for Track events.
70+
71+
72+
## Audit trail
73+
74+
The Audit trail displays all audit actions that occur in your Unify space. This can include, for example, a user creating an access token or modifying Unify settings.
75+
76+
Click an audit log link to view the user who initiated the action, timestamp, and log details.
77+
78+

src/unify/profiles-sync/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To learn more about Profiles Sync, visit the following docs:
5050
- [Profiles Sync Setup](/docs/unify/profiles-sync/): Learn how to set up Profiles Sync, enable historical backfill, and adjust settings for warehouses you've connected.
5151
- [Sample Queries](/docs/unify/profiles-sync/sample-queries/): View sample queries you can run to help you familiarize yourself with Profiles Sync.
5252
- [Tables and materialized views](/docs/unify/profiles-sync/tables/): Learn how to use data sets and models that Segment provides to enrich customer profiles.
53-
53+
5454

5555
> info ""
5656
> For more on Profiles Sync logic, table mappings, and data types, download this [Profiles Sync ERD](/docs/unify/files/ERD.png).

0 commit comments

Comments
 (0)