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.

Query Parameters

Name	Type	Description
type	string	The type of events to retrieve. Accepted values: `errored`, `queued`, or `processed`.
contactKey	string	A contact key to retrieve event data for.
requestId	string	A request ID to retrieve event data for.
eventInstanceId	string	An event instance ID to retrieve event data for. This field name is reserved for system use. If you have a field in your payload with the same name, the data value for it is ignored, and a random GUID is logged to the data extension.
eventDefinitionKey	string	An event definition key to retrieve event data for.
$page	string	The 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.
$pageSize	string	The number of records to return on each page of results. The default value is 50.
startDate	string	The starting date and time for your query. By default, the API retrieves the last 30 days of data.
endDate	string	The end date and time for your query.
$orderBy	string	The 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.

Important

Response

Name	Type	Description
page	string	The current page of results.
pageSize	string	The number of records in the current page of results.
count	int	The 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.
items	array	An array that contains the events that were retrieved.
items.eventCategoryType	string	The status of the event. Possible values: `Queued`, `Processed`, or `Errored`
items.timestamp	string	Time the event occurred in Central Standard Time.
items.eventDefinitionKey	string	The eventDefinitionKey associated with this event.
items.requestId	string	The request ID from the original POST response.
items.info	object	An object that contains information about the contact or instance.
items.info.contactKey	string	Unique identifier for a subscriber.
items.info.eventInstanceId	string	Unique identifier for the instance of processing in the batch, used to track end-to-end progress.
items.info.errorcode	string	An error code. The response only includes this property if there was an error in processing an event instance.
items.info.message	string	An error message associated with the error code. The response only includes this property if there was an error in processing an event instance.

Error Codes

Error Code	Scenario	Message
10001	Get Request Contains Invalid Parameter	Request contains invalid parameter. Remove the parameter: {variable}
10001	Get Request Contains Extra or Duplicate Parameter	Request contains duplicate parameter. Remove the duplicate parameter: {variable}
10001	Get Request Contains Invalid Sort Parameter	Request contains invalid sort or order parameter value. Remove the parameter value: {variable}
10002	Get Request Sorting Required Param Missing	Enter a required filter parameter and try again. When sorting or ordering, at least one of these parameters is required: contactKey, eventInstanceId, or requestId.
10005	Get Request Page Size Exceeded Limit	Enter a valid pageSize and try again. Request pageSize must be between 1 and 10000
10005	Get Request Exceeded Search Limit	Request exceeds search limit. Reduce page or pageSize to not exceed a search depth of more than 10000 total records.

Response Example

A successful request includes the information shown in this example.

1{
2  "page": 1,
3  "pageSize": 50,
4  "count": 2,
5  "items": [
6    {
7      "eventCategoryType": "Processed",
8      "timestamp": "2023-08-05T13:41:18.55-06:00",
9      "eventDefinitionKey": "BatchJourneyExample",
10      "requestId": "c77598e6-cae3-4244-913b-6231e6e8a17b",
11      "info": {
12        "contactKey": "5b78e18e-9249-4392-a18f-da46b7198015",
13        "eventInstanceId": "56277a0a-2781-4730-bdfa-7e2f91e33b9d"
14      }
15    },
16    {
17      "eventCategoryType": "Queued",
18      "timestamp": "2023-08-05T13:42:19.82-06:00",
19      "eventDefinitionKey": "BatchJourneyExample",
20      "requestId": "c77598e6-cae3-4244-913b-6231e6e8a17b",
21      "info": {
22        "contactKey": "acc4935f-327a-4d51-bd39-f42071009c54",
23        "eventInstanceId": "0b06685d-ada0-474b-86f9-2630a75537eb"
24      }
25    }
26  ]
27}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!