Segment Engage & Unify

This documentation for the Segment Engage & Unify integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Segment Engage & Unify, visit our connection instructions.

Version

This integration utilizes the Segment Engage & Unify REST API v1.

Base URL

The base URL used for all Segment Engage & Unify API endpoints contains the Hostname and Space ID:

https://hostname/v1/spaces/space_id

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/collections/users/profiles	Validate credentials

---

Authentication & Authorization

The DataGrail Segment Engage & Unify integration connects using token authentication which requires an API token.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Segment Engage & Unify API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

---

Limits

Limits in Segment Engage & Unify are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Segment Engage & Unify integration provides Synchronous Access capabilities for the following supported identifier categories: Email and User ID.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Fetch list of users.
2. Select users by the Data Subject email.
3. Fetch user details by ID for all collected users.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/collections/users/profiles/identifier_category_key:identifier_value/events	Fetch events
GET	/collections/users/profiles/identifier_category_key:identifier_value/traits	Fetch traits
GET	/users	Fetch list of users
GET	/users/user_Id:	Fetch user details by ID

---