Segment Details
GET https://{{instance_url}}/segments/details?segment_id={{segment_identifier}}
This endpoint allows you to retrieve relevant information on the segment, which can be identified by the segment_id
.
Request Components
Response
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"created_at" : (string) date created as ISO 8601 date,
"updated_at" : (string) date last updated as ISO 8601 date,
"name" : (string) segment name,
"description" : (string) human-readable description of filters,
"text_description" : (string) segment description,
"tags" : (array) tag names associated with the segment
}
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
segment_id | string | (Required) String |
Segment API identifier |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |