Skip to navigation
API ReferenceMessages

Search time series

Search the content of recently sent messages and return the aggregated hourly stats for matching messages.

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
querystringOptional
the search terms to find matching messages for
date_fromdate or nullOptional
start date
date_todate or nullOptional
end date
tagslist of strings or nullOptional
an array of tag names to narrow the search to, will return messages that contain ANY of the tags
senderslist of strings or nullOptional
an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders

Response

Success
timestringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"
The hour that the statistic occurred
sentinteger
The number of emails sent during the time period
opensinteger
The number of emails opened during the time period
clicksinteger
The number of clicks during the time period
hard_bouncesinteger
The number of hard bounces during the time period
soft_bouncesinteger
The number of soft bounces during the time period
rejectsinteger
The number of emails rejected during the time period
complaintsinteger
The number of spam complaints during the time period
unsubsinteger
The number of unsubscribes during the time period
unique_opensinteger
The number of unique opens during the time period
unique_clicksinteger
The number of unique clicks during the time period

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error