Segment List

v1.0.0

This endpoint allows you to export a list of segments, each of which will include its name, Segment API Identifier, and whether it has analytics tracking enabled. The segments are returned in groups of 100 sorted by time of creation (oldest to newest by default). Archived segments are not included.

Request Components

Response

json

Content-Type: application/jsonAuthorization: Bearer YOUR-REST-API-KEY{    "message": (required, string) the status of the export, returns 'success' when completed without errors,    "segments" : [        {            "id" : (string) Segment API Identifier,            "name" : (string) segment name,            "analytics_tracking_enabled" : (boolean) whether the segment has analytics tracking enabled,            "tags" : (array) tag names associated with the segment        },        ...    ]}

Input

{
  "type": "object",
  "properties": {
    "page": {
      "type": "string"
    },
    "sort_direction": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}