Segment Public

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

Version

This integration utilizes the Segment Public API v1.

Base URL

The base URL used for all Segment Public API endpoints:

https​://api.segmentapis.com

Endpoints Utilized

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

Method	Endpoint	Purpose	Docs
GET	https​://api.segmentapis.com/	Validate credentials

---

Authentication & Authorization

The DataGrail Segment Public integration connects using api-token authentication which requires an API Token.

Sensitive Credentials

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

---

Limits

Limits in Segment Public 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 Public integration provides Asynchronous 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 with access to the Workspace.
2. Select users using configured identifiers.
3. Fetch user details by ID for all collected users.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/users	Returns a list of users with access to the Workspace
GET	/users/userId	Returns a user given their id

---

Deletion

DataGrail's Segment Public integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier categories: Email and User ID.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Fetch list of users with access to the Workspace.
2. Select users using configured identifiers.
3. Create a Workspace Regulation.
4. Get regulation from the Workspace.
5. Complete processing when the overall status is FINISHED.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/regulations	Create Workspace Regulation
GET	/regulations/regulation_id	Gets a regulation from the Workspace
GET	/users	Returns a list of users with access to the Workspace

---

Opt Out

DataGrail's Segment Public integration provides Opt Out capabilities for the following supported identifier categories: Email and User ID.

Data Interactions

For Opt Out requests, DataGrail will take the following actions:

1. Create a Workspace Regulation.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/regulations	Create Workspace Regulation

---

System Detection

DataGrail provides continuous system detection, delivering a real-time inventory of your data assets.

Data Interactions

DataGrail's System Detection process runs once daily and performs the following actions:

1. Fetch list of sources.
2. Fetch list of destinations.
3. Fetch list of warehouses.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/destinations	Returns a list of Destinations
GET	/sources	Returns a list of Sources
GET	/warehouses	Returns a list of Warehouses

---