Admin SMS Stats

Get SMS/message statistics for a tenant with optional filters

POST /v2/admin/reporting/messages/stats

Admin SMS Stats

cURL

curl --request POST \
  --url https://api.voxo.co/v2/admin/reporting/messages/stats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "startDate": "<string>",
  "endDate": "<string>"
}
'

200

{
  "tenantId": 123,
  "results": [
    {
      "inbound": 123,
      "outbound": 123,
      "total": 123,
      "distribution": "<string>",
      "peerName": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

tenantId · number · required

Tenant ID

Required range: x > 0

startDate · string · required

Start date for the report period

endDate · string · required

End date for the report period

distribution · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string>

Time distribution grouping (daily, weekly, monthly, or totals)

Available options: weekly

users · string[] enum<string>

Filter by user peer names, or 'ALL' for all users

groups · object[]

Filter by groups (queue, huntlist, or branch)

Show child attributes

phoneNumber · string[]

Filter by phone numbers

direction · Option 1 · enum<string> Option 2 · enum<string>

Message direction filter (inbound or outbound)

Available options: inbound

Response

200

application/json

SMS statistics or export acknowledgement

Option 1

Option 2

SMS statistics

tenantId · number · required

Tenant ID

results · object[] · required

SMS statistics results

Show child attributes