Skip to navigation

Export activity history

Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv with message details and custom metadata fields.

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
notify_emailstringOptionalformat: "email"
Optional email address to notify when the export job has finished
date_fromstringOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

Start date as a UTC string in YYYY-MM-DD HH:MM:SS format

date_tostringOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

End date as a UTC string in YYYY-MM-DD HH:MM:SS format

tagslist of stringsOptional

Array of tag names to narrow the export to; will match messages that contain ANY of the tags

senderslist of stringsOptional
Array of sender email addresses to narrow the export to
stateslist of enumsOptional

Array of message states to narrow the export to; messages with ANY of the states will be included

api_keyslist of stringsOptional

Array of API keys to narrow the export to; messages sent with ANY of the keys will be included

Response

Success

Errors

401
Unauthorized Error
500
Internal Server Error