v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Segments

Get big segment export

Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries.

get/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

segmentKeystring string required

The segment key

exportIDstring string required

The export ID

Response

Segment export response

idstring required

The export ID

segmentKeystring required

The segment key

creationTimeinteger required

statusstring required

The export status

sizeBytesinteger required

The export size, in bytes

sizestring required

The export size, with units

_linksobject required

The location and content type of related resources, including the location of the exported file

Example response

{
  "id": "1234a567-bcd8-9123-4567-abcd1234567f",
  "segmentKey": "example-big-segment",
  "status": "complete",
  "sizeBytes": 18,
  "size": "18 B",
  "initiator": {
    "name": "Bob Loblaw",
    "email": "ariel@acme.com"
  }
}