Skip to navigation
Campaigns

Get aggregate SMS campaign stats

View as Markdown

One set of stats totalled across SMS campaigns. Counts and revenue are summed; rates are recalculated from the summed counts. sent_after is inclusive and sent_before exclusive.

Authentication

AuthorizationBearer

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

Headers

X-Partner-IdstringRequired
Your OAuth application client ID.

Query parameters

campaign_idsstringOptional>=1 character

Comma-separated campaign IDs, max 100.

sent_afterdatetimeOptional
sent_beforedatetimeOptional

Response

campaigns_includedinteger
stats_refreshed_atdatetime or null
statsobject or null
Explicit, versioned view over the stats dict assembled by SMSCampaignsService. The cached subdocuments are never passed through, so internal key changes can't break API consumers.

Errors

422
Unprocessable Entity Error