Outpost DocsAPI ReferenceStats
Get activity dashboard statistics
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
startDate?string
Format
date-timeendDate?string
Format
date-timetenantId?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/stats/activity"{ "messageStats": { "total": 0, "delivered": 0, "failed": 0, "growth": 0, "deliveryRate": 0 }, "phoneStats": { "active": 0, "optedOut": 0, "optOutRate": 0, "optOutTrend": 0 }, "volumeData": [ { "timestamp": 0, "sent": 0, "delivered": 0, "failed": 0 } ], "recentActivity": [ { "messageId": "string", "phone": "string", "status": "PENDING", "timestamp": 0 } ]}