Outpost DocsAPI ReferenceStats
Get top communications by metric
Get top communications by metric (message count or cost), enriched with entity data
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
metric?string
Default
"SMS_COUNT"Value in
- "SMS_COUNT"
- "SMS_COST"
limit?string
Default
"10"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/stats/communications/top"{ "data": [ { "communicationId": "string", "metricValue": 0, "tenantId": "string", "name": "string", "campaignId": "string", "status": "active", "createdAt": 0, "updatedAt": 0, "firstMessageAt": 0, "lastMessageAt": 0 } ]}