Analytics

Get message volume analytics

Returns outbound message counts over the half-open selected instant range, grouped by organization-local calendar day, week, or month.

GET
/v1/analytics/stats

Returns outbound message counts over the half-open selected instant range, grouped by organization-local calendar day, week, or month. A range with traffic returns every bucket in it, including the ones that saw none; a range with no outbound traffic at all returns no buckets. A range with no endDate runs through the current instant, so its quiet trailing buckets are reported as zero.

x-api-key<token>

In: header

Query Parameters

startDate?|null
endDate?|null
groupBy?|null
channel?|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/stats"
{  "volumeHistory": [    {      "date": "string",      "email": 0    }  ]}