API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve status

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

accessTokeninteger Required

Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.

Response

200
Object

Success

Response Attributes

AccessTokeninteger

Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.

Statusstring | null

The Status of the export. 'Processing', 'Error', 'Expired', 'Retrieved', or 'Complete'.

Enum values:
Processing
The export request has been received and is currently being processed.
Error
The export failed to execute. You must validate your segment configuration and retry your request.
Expired
The export was successfully generated, but it wasn't retrieved before the access token expired.
Failed
The API user does not have the required permissions to retrieve data.
Complete
The export was processed successfully, and the data is ready for retrieval.
Retrieved
The export data was successfully retrieved.
RowCountinteger | null

Total amount of rows that have been retrieved by the export. This value is only available after the entire export is complete.

ByteCountinteger | null

Total size of the export in bytes. This value is only available after the entire export is complete.

400
Object

Bad Request

401
Object

Unauthorized

403
Object

Forbidden

404
Object

Not Found

503
Object

Server Error

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?