Outpost DocsAPI ReferenceStats
Get message volume over a time range
Get message volume chart data (delivered/failed/blocked) over a time range
x-api-key<token>
Project-scoped API key. Keys carry either the ADMIN or TENANT role; a route additionally requires that the key's role is listed in its x-required-roles. Machine-to-machine callers should use this.
In: header
Query Parameters
window?string
Default
"DAY"Value in
- "HOUR"
- "DAY"
- "MONTH"
- "ALL_TIME"
dimension?string
Default
"GLOBAL"Value in
- "GLOBAL"
- "TENANT"
- "PROJECT"
- "CAMPAIGN"
- "PHONE"
- "COMMUNICATION"
- "COUNTRY"
dimensionValue?string
Default
"ALL"start*string
end*string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/stats/message-volume?start=string&end=string"{ "data": [ { "timestamp": "string", "delivered": 0, "failed": 0, "blocked": 0 } ]}