Reporting Data Export

Everything about Reporting Data Export. See this article for details on using the data to generate various metrics.

Operations

Enqueue a new reporting data export job

Request

For the conversation dataset, from the Preview version this export returns all conversations, including those that never received a user reply. Earlier versions return only conversations that received at least one user reply. Other datasets are unaffected.

Security

bearerAuth

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/jsonrequired

dataset_idstringrequired

Example:"conversation"

attribute_idsArray of stringsrequired

List of attribute identifiers to include in the export. Requires qualified_id format (e.g., "people.Brand", "standard.conversation_id"). Use the qualified_id returned from the get_datasets response.

Example:

[
  "conversation_id",
  "conversation_started_at"
]

start_timeinteger, (int64)required

Example:1717490000

end_timeinteger, (int64)required

Example:1717510000

curl -i -X POST \
  https://api.intercom.io/export/reporting_data/enqueue \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "dataset_id": "conversation",
    "attribute_ids": [
      "conversation_id",
      "conversation_started_at"
    ],
    "start_time": 1717490000,
    "end_time": 1717510000
  }'

Responses

Job enqueued successfully

Bodyapplication/json

job_identifierstring

Example:"job1"

statusstring

Example:"pending"

download_urlstring

download_expires_atstring

Response

{
  "job_identifier": "job1",
  "status": "pending",
  "download_url": "string",
  "download_expires_at": "string"
}