Returns detailed status information for all transmissions for a given project.
Request Fields
These are passed in as arguments
at the top level of the request.
Key | Type | Description |
---|---|---|
from | string Optional |
Start date of results. Default: 1 |
to | string Optional |
End date of results. Default: 1 |
page | integer Optional |
Page of results to retrieve. Default: 1 |
page | integer Optional |
Page of results to retrieve. Default: 1 |
per_page | integer Optional |
How many results to return per page. Default: 250 |
Request Example
A date range can be specified with a combination of from
and to
using
an ISO-8601 formatted date (YYYY-MM-DD
).
These arguments are optional.
{
"api_key": "PROJECT_API_KEY",
"arguments": {
"from": "2017-10-01",
"to": "2017-10-02"
}
}
Response 200 OK
The response is a breakdown of individual transmission records for this account.
{
"response": {
"status": "ok",
"uid": null
},
"data": {
"messages_history": [
{
"unique_id": "36598cc85e020a01384ea7653872c8e87536869c@mailer.postageapp.com",
"message_id": 23490345,
"uid": "36598cc85e020a01384ea7653872c8e87536869c",
"recipient": "recipient@example.com",
"status": "completed",
"created_at": "2017-03-30 21:24:41",
},
{
"unique_id": "cdfc8a4254ab3f44f37f0de9b50f6a3cb402030a@mailer.postageapp.com",
"message_id": 23490491,
"uid": "cdfc8a4254ab3f44f37f0de9b50f6a3cb402030a",
"recipient": "recipient@example.net",
"status": "completed",
"created_at": "2017-03-30 21:25:29",
},
]
}
}