POST /interaction/v1/interactions/journeyhistory/estimate

Returns an estimate of the number of rows that the journey history download request generates for a given query. The response also includes an estimate of the file size in bytes, with and without compression. The syntax of this operation is similar to the syntax of the journey history download request operation. The endpoint, response body, and headers differ between the two operations.

We recommend that you request an estimate before you submit a journey history download request. If the compressed file size estimate exceeds 1 GB, limit the scope of the request to include less data.

URL Parameters

Name	Type	Description
`columns`	String	Comma-separated list of columns to download. The default value is `TransactionTime, ContactKey, Status, DefinitionId, DefinitionName, ActivityId, ActivityName, ActivityType`. Possible values: <ul><li>`ActivityId`</li><li>`ActivityName`</li><li>`ActivityType`</li><li>`ClientStatus`</li><li>`ContactKey`</li><li>`CreatedDate`</li><li>`DefinitionId`</li><li>`DefinitionInstanceId`</li><li>`DefinitionName`</li><li>`EndDate`</li><li>`EntrySource`</li><li>`EpochTimeInMilliseconds`</li><li>`EventId`</li><li>`EventName`</li><li>`Id`</li><li>`Message`</li><li>`OutcomeActivityId`</li><li>`Result.Messages`</li><li>`Result.Outcome`</li><li>`Result.Status`</li><li>`Result.Tags`</li><li>`SourceType`</li><li>`StartDate`</li><li>`Status`</li><li>`TransactionTime`</li></ul>
`format`	String	The format to use for the output file. The default value is `csv`. Possible values: <ul><li>`csv`</li><li>`tsv`</li></ul>

JSON Parameters

The request body can contain any of the values in this table.

Name	Type	Description
`activityIds`	Array	A list of activity IDs to retrieve events for.
`activityTypes`	Array	A list of activity types to retrieve events for. Possible values: <ul><li>`abntest`</li><li>`abnteststop`</li><li>`activeaudiencejourneyactivity`</li><li>`einsteinengagementfrequencysplit`</li><li>`emailv2`</li><li>`engagementdecision`</li><li>`exitcriteriaactivity`</li><li>`goalcriteriaactivity`</li><li>`inappsyncactivity`</li><li>`multicriteriadecision`</li><li>`multicriteriadecisionextension`</li><li>`pushinboxactivity`</li><li>`pushnotificationactivity`</li><li>`pushsync`</li><li>`randomsplit`</li><li>`rest`</li><li>`restdecision`</li><li>`salescloudactivity`</li><li>`salesforceleadconversionactivity`</li><li>`sendtolinesync`</li><li>`smssync`</li><li>`startinteractionactivity`</li><li>`stopinteractionactivity`</li><li>`stowait`</li><li>`trigger`</li><li>`updatecontactdata`</li><li>`wait`</li><li>`waitactivity`</li><li>`waituntilapi`</li><li>`waituntilchatresponse`</li><li>`waituntilpushengagement`</li><li>`whatsappactivity`</li></ul>
`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. Possible values: <ul><li>`Active`</li><li>`Complete`</li><li>`ContactAlreadyInInteraction`</li><li>`ContactExitedAsOutOfMarketAudienceSegment`</li><li>`ContactExitedByApi`</li><li>`ContactIsDeleted`</li><li>`ContactIsRestricted`</li><li>`ContactKeyNotProvided`</li><li>`ContactNotFound`</li><li>`ContactObjectNull`</li><li>`ContactPreviouslyInSameInteraction`</li><li>`ContactStatusIsUnknown`</li><li>`CouldNotParseInteractionId`</li><li>`CurrentlyWaitingInSameInteraction`</li><li>`Deactivated`</li><li>`DidNotMeetEntryCriteria`</li><li>`ErrorDeterminingInitialActivity`</li><li>`ErrorOccurredinProcessing`</li><li>`ErrorProcessingWaitActivity`</li><li>`ErrorValidatingContact`</li><li>`ExitCriteriaMet`</li><li>`Failed`</li><li>`GoalCriteriaAlreadyMet`</li><li>`GoalCriteriaMet`</li><li>`GoalCriteriaMetInWait`</li><li>`GoalCriteriaNotMet`</li><li>`GoalNotDefined`</li><li>`InteractionNotPublished`</li><li>`InvalidInteractionId`</li><li>`MetCriteria`</li><li>`MovedToHigherPriorityInteraction`</li><li>`NotEvaluatingEntryCriteria`</li><li>`StoppedByUser`</li><li>`UnableToDeserializeMessage`</li><li>`Unknown`</li><li>`WaitActivtyAlreadyProcessed`</li><li>`Waiting`</li><li>`WaitingForAsync`</li><li>`WaitUntilEventCriteriaMet`</li><li>`WaitUntilEventCriteriaNotMet`</li></ul>
`tags`	Array	A list of tags to retrieve events for.

Usage

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.

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /interaction/v1/interactions/journeyhistory/estimate?columns=ActivityId,ContactKey
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
{
  "start": "2024-07-11T06:00:00Z",
  "end": "2024-07-11T21:00:00Z",
  "definitionIds": ["58c2edb1-703e-45d8-9841-9e5d63ed1117"],
  "statuses": ["failed"]
}

The response lists the approximate number of rows in the result set. It also provides an estimate of the compressed and uncompressed file size in bytes.

{
  "rowCount": 3,
  "downloadSize": 2048,
  "compressedSize": 205
}