Skip to content

/domains/{id}/stats

GET
/domains/{id}/stats
curl --request GET \
--url 'https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats?days=7' \
--header 'Authorization: Bearer <token>'

Mail to and from one domain over the window, from the delivery log: deliveries received, refused, sent, failed and deferred, and a daily series. Counted per recipient.

id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
days
integer
default: 7 >= 1 <= 90

Default Response

Media typeapplication/json
object
days
required
integer
>= -9007199254740991 <= 9007199254740991
received
required
integer
>= -9007199254740991 <= 9007199254740991
refused
required
integer
>= -9007199254740991 <= 9007199254740991
sent
required
integer
>= -9007199254740991 <= 9007199254740991
failed
required
integer
>= -9007199254740991 <= 9007199254740991
deferred
required
integer
>= -9007199254740991 <= 9007199254740991
daily
required
Array<object>
object
date
required
string
received
required
integer
>= -9007199254740991 <= 9007199254740991
sent
required
integer
>= -9007199254740991 <= 9007199254740991
failed
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
"days": 1,
"received": 1,
"refused": 1,
"sent": 1,
"failed": 1,
"deferred": 1,
"daily": [
{
"date": "example",
"received": 1,
"sent": 1,
"failed": 1
}
]
}