Intercom API (unofficial showcase)
POST/export/reporting_data/enqueue

Enqueue a reporting data export

Enqueues a reporting data export job for a selected dataset, attributes, and time range. Supply dataset_id, attribute_ids, start_time, and end_time; for conversation exports in the current API version, the export includes conversations that received no user reply. Use the returned job identifier to check the job status and retrieve its data.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 4 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Reporting data export configuration. All four fields are required.

dataset_idstringrequired
The identifier of the dataset to export.
attribute_idsarray<string>required
Identifiers of the dataset attributes to include in the export.
start_timeintegerrequired
The start of the export time range, as a 64-bit integer.
end_timeintegerrequired
The end of the export time range, as a 64-bit integer.

4 status codes
200Returns the export job identifier and status, with a download URL and its expiration time when available.
job_identifierstringoptional
statusstringoptional
download_urlstringoptional
download_expires_atstringoptional
400Returned when the request is invalid, such as when a required field is missing or a value fails validation.

One documented failure

  • bad_request

    'dataset_id' is a required parameter

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
429Returned when too many export jobs are in progress.

One documented failure

  • rate_limit_exceeded

    Exceeded rate limit of 5 pending reporting dataset export jobs

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the request is invalid, including when required fields are missing or values fail validation. A 401 is returned when the request is unauthorized, and a 429 is returned when too many export jobs are in progress. Include dataset_id, attribute_ids, start_time, and end_time; both time fields must be 64-bit integers.