Sign in

v5

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

Get big segment import

Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries.

get/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}

Path parameters

projectKeystring string required

The project key

The project key

environmentKeystring string required

The environment key

The environment key

segmentKeystring string required

The segment key

The segment key

importIDstring string required

The import ID

The import ID

Response

Segment import response

idstring required

The import ID

segmentKeystring required

The segment key

creationTimeinteger required
modestring required

The import mode used, either <code>merge</code> or <code>replace</code>

status'preparing' | 'pending_approval' | 'ready' | 'in_progress' | 'complete' | 'stopped' required

The import status

_linksobject required

The location and content type of related resources

Example response

{
  "id": "1234a567-bcd8-9123-4567-abcd1234567f",
  "segmentKey": "example-big-segment",
  "mode": "replace",
  "status": "complete",
  "files": [
    {
      "filename": "bigsegimport.csv",
      "status": "complete"
    }
  ]
}