Segment List

GET https://{{instance_url}}/segments/list?page=1&sort_direction=desc

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

• Segment Identifier

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,
    "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
        },
        ...
    ]
}

Request Params

The page of segments to return, defaults to 0 (returns the first set of up to 100) | | sort_direction | string | | (Optional) String

Pass in the value desc to sort by creation time from newest to oldest. Pass in asc to sort from oldest to newest. If sort_direction is not included, the default order is oldest to newest. |

HEADERS