GET /interaction/v1/async/events/status

Retrieve the status of contacts that were inserted into a journey using the POST method. Use this operation for troubleshooting batch insertion requests.

To export large amounts of data, use the Download History API instead.

typestringThe type of events to retrieve. Accepted values: errored, queued, or processed.
contactKeystringA contact key to retrieve event data for.
requestIdstringA request ID to retrieve event data for.
eventInstanceIdstringAn event instance ID to retrieve event data for.
eventDefinitionKeystringAn event definition key to retrieve event data for.
$pagestringThe page of results to retrieve. Each page includes the number of records specified by the $pageSize parameter. You can retrieve additional pages by incrementing this number in subsequent calls.
$pageSizestringThe number of records to return on each page of results. The default value is 50.
startDatestringThe starting date and time for your query. By default, the API retrieves the last 30 days of data.
endDatestringThe end date and time for your query.
$orderBystringThe field and sort method to use to sort the results. You can sort based on the modifiedDate in ascending (ASC) or descending (DESC) order. Order by timestamp. If you specify this parameter, you must also specify requestId, contactKey, or eventInstanceId. The default value is modifiedDate.

Your request must specify one or more of these parameters:

  • type
  • contactKey
  • requestId
  • eventInstanceId
  • eventDefinitionKey

If your request doesn’t include any of these parameters, the API returns an error.

pagestringThe current page of results.
pageSizestringThe number of records in the current page of results.
countintThe total number of events in the response. If the value of count is greater than pageSize, you can issue additional GET requests to retrieve additional information. Increment the $page value in each subsequent request.
itemsarrayAn array that contains the events that were retrieved.
items.eventCategoryTypestringThe status of the event. Possible values: Queued, Processed, or Errored
items.timestampstringTime the event occurred in Central Standard Time.
items.eventDefinitionKeystringThe eventDefinitionKey associated with this event.
items.requestIdstringThe request ID from the original POST response.
items.infoobjectAn object that contains information about the contact or instance. identifier for a subscriber. identifier for the instance of processing in the batch, used to track end-to-end progress. error code. The response only includes this property if there was an error in processing an event instance. error message associated with the error code. The response only includes this property if there was an error in processing an event instance.
Error CodeScenarioMessage
10001Get Request Contains Invalid ParameterRequest contains invalid parameter. Remove the parameter: {variable}
10001Get Request Contains Extra or Duplicate ParameterRequest contains duplicate parameter. Remove the duplicate parameter: {variable}
10001Get Request Contains Invalid Sort ParameterRequest contains invalid sort or order parameter value. Remove the parameter value: {variable}
10002Get Request Sorting Required Param MissingEnter a required filter parameter and try again. When sorting or ordering, at least one of these parameters is required: contactKey, eventInstanceId, or requestId.
10005Get Request Page Size Exceeded LimitEnter a valid pageSize and try again. Request pageSize must be between 1 and 10000
10005Get Request Exceeded Search LimitRequest exceeds search limit. Reduce page or pageSize to not exceed a search depth of more than 10000 total records.

A successful request includes the information shown in this example.