POST /interaction/v1/interactions/journeyhistory/estimate

Returns an estimate of the file size and number of rows generated if you issue a journey history download request.

Journey history downloads are limited to 1 GB, so it’s helpful to use this operation to get a file size estimate before requesting the journey history download.

The syntax of this operation is the same as the journey history download request operation. Only the endpoint and the response body are different between the two operations.

Name	Type	Description	Accepted Values
format	string	The format to use for the output file. The default value is csv.	tsv csv
columns	string	Comma-separated list of columns to download. The default value is TransactionTime, ContactKey, Status, DefinitionId, DefinitionName, ActivityId, ActivityName, ActivityType.	ActivityId ActivityName ActivityType CilentStatus ContactKey CreatedDate DefintionId DefintionInstanceId DefinitionName EndDate EntrySource EpochTimeInMilliseconds EventId EventName Id Message OutcomeActivityId SourceType StartDate Status TransactionTime Result.Status Result.Tags Result.Messages Result.Outcome

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

Name	Type	Description	Possible Values
start	string	The start date and time for the query, in ISO 8601 format.
end	string	The end date and time for the query, in ISO 8601 format.
contactKeys	array	A comma-separated list of contact keys to retrieve events for.
activityTypes	array	A list of activity types to retrieve events for.	waitactivity multicriteriadecision trigger startinteractionactivity stopinteractionactivity rest emailv2 updatecontactdata randomsplit salescloudactivity stowait goalcriteriaactivity exitcriteriaactivity pushnotificationactivity engagementdecision pushinboxactivity multicriteriadecisionextension smssync abntest abnteststop restdecision inappsyncactivity einsteinengagementfrequencysplit activeaudiencejourneyactivity wait sendtolinesync waituntilpushengagement pushsync waituntilapi whatsappactivity salesforceleadconversionactivity waituntilchatresponse
definitionIds	array	A list of definition (journey) IDs to retrieve events for.
statuses	array	A list of statuses to retrieve events for.	Active Waiting Complete Failed Unknown DidNotMeetEntryCriteria GoalCriteriaAlreadyMet GoalCriteriaNotMet GoalCriteriaMet GoalCriteriaMetInWait MetCriteria ErrorProcessingWaitActivity ErrorOccurredinProcessing ErrorValidatingContact InvalidInteractionId UnableToDeserializeMessage WaitActivtyAlreadyProcessed CouldNotParseInteractionId InteractionNotPublished ContactNotFound CurrentlyWaitingInSameInteraction ContactAlreadyInInteraction ContactObjectNull NotEvaluatingEntryCriteria ErrorDeterminingInitialActivity MovedToHigherPriorityInteraction Deactivated ContactPreviouslyInSameInteraction WaitingForAsync GoalNotDefined StoppedByUser ContactKeyNotProvided ExitCriteriaMet WaitUntilEventCriteriaMet WaitUntilEventCriteriaNotMet ContactIsDeleted ContactIsRestricted ContactExitedByApi ContactStatusIsUnknown ContactExitedAsOutOfMarketAudienceSegment
definitionInstanceIds	array	A list of definition instance IDs to retrieve events for.
tags	array	A list of tags to retrieve events for.
activityIds	array	A list of activity IDs 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 file size.