Statistics

1 endpoints in this family.

Get delivery statistics

GET/api/v1/stats/delivery

Counts what became of the messages you sent over a period: sent, delivered, read, replied, failed and skipped, per day and per template (or per broadcast). The default period is the last 30 days; it cannot exceed 366 days. previous holds the same counts for the period of equal length just before, to compare.

Definitions. sent counts every message whose sending was attempted, failures included. delivered includes read. replied counts messages after which the contact wrote within 24 hours. skipped counts the recipients a broadcast left out before sending (no consent, no number) and is 0 for templates.

A message is counted on the day it was sent, with its current status: the exact time of a read is not kept.

Query parameters

fromstring
Start of the period (ISO 8601). Default: to minus 30 days.
tostring
End of the period, excluded (ISO 8601). Default: now.
sourcestring
template (default) counts template messages and groups them by template; broadcast counts broadcast messages and groups them by broadcast.
templatebroadcast
channelIdstring
Only the messages of this channel (a number).

Response

The counts of the period, per day and per template or broadcast.

data.fromstring
ISO 8601.
data.tostring
ISO 8601.
data.sourcestring
What was counted.
templatebroadcast
data.totalsobject
sent, delivered, read, replied, failed, skipped.
data.previousobject
The same counts for the period of equal length just before.
data.daysobject[]
Per day (UTC): day, sent, delivered.
data.groupsobject[]
Per template or per broadcast (at most 50): key, label, sent, delivered, read, replied, failed.

curl https://nodium.io/api/v1/stats/delivery \ -H "Authorization: Bearer $NODIUM_KEY"

Response

200 OK

{  "data": {    "from": "…",    "to": "…",    "source": "template",    "totals": {},    "previous": {},    "days": [      {}    ],    "groups": [      {}    ]  }}