POST /interaction/v1/interactions/journeyhistory/estimate
Returns an estimate of the file size in bytes and the number of rows generated if you issue a journey history download request.
Journey history downloads are limited to 1 GB and can't be resumed, so requesting a file size estimate before you submit a journey history download request can save time and effort.
The syntax of this operation is the same as the journey history download request operation. Only the endpoint and the response body differ between the two operations.
Name | Type | Description | Accepted Values |
---|---|---|---|
columns | String | Comma-separated list of columns to download. The default value is TransactionTime, ContactKey, Status, DefinitionId, DefinitionName, ActivityId, ActivityName, ActivityType . |
|
format | String | The format to use for the output file. The default value is csv . |
|
The request body can contain any of the values in this table.
Name | Type | Description | Possible Values |
---|---|---|---|
activityIds | Array | A list of activity IDs to retrieve events for. | |
activityTypes | Array | A list of activity types to retrieve events for. |
|
contactKeys | Array | A comma-separated list of contact keys to retrieve events for. | |
definitionIds | Array | A list of definition (journey) IDs to retrieve events for. | |
definitionInstanceIds | Array | A list of definition instance IDs to retrieve events for. | |
end | String | The end date and time for the query, in ISO 8601 format. | |
start | String | The start date and time for the query, in ISO 8601 format. | |
statuses | Array | A list of statuses to retrieve events for. |
|
tags | Array | A list of tags to retrieve events for. |
This example provides an estimate for a query that returns the values in the ActivityId
and ContactKey
columns for contacts that failed to enter a journey. The query is limited to a specific time period.
The response lists the approximate number of rows and the estimated file size in bytes.