MAmailchimp
batches

Get batch operation status

Get the status of a batch request.

get/3.0/batches/{batch_id}

Request

Path parameters

batch_idstring required

The unique id for the batch operation.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

errored_operationsinteger

The number of completed operations that returned an error.

finished_operationsinteger

The number of completed operations. This includes operations that returned an error.

idstring

A string that uniquely identifies this batch request.

response_body_urlstring

The URL of the gzipped archive of the results of all the operations.

status'pending' | 'preprocessing' | 'started' | 'finalizing' | 'finished'

The status of the batch call. Learn more about the batch operation status.

submitted_atstring date-time

The date and time when the server received the batch request in ISO 8601 format.

total_operationsinteger

The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.

Changes

No recorded changes to this operation across all 1 revision of this API.