Link Search Menu Expand Document

Updated Fri Jun 18th 2021, 16:17 UTC

Stats

GET /:account/deliveries/stats

Note: This endpoint is still under active development, and may change without warning.

Accounts have a limit to how many campaign messages can be sent per day. This endpoint provides a convienient endpoint for displaying that limit along with the number of messages delivered so far and the number still scheduled to be delivered today.

Examples

Show Campaign delivery stats for an Account

Request

GET /my_account/deliveries/stats
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/deliveries/stats
    

Response

Status

200

Response Type

DeliveryStats

Example
{
  "@type": "DeliveryStats",
  "@context": "/contexts/DeliveryStats.jsonld",
  "id": "/my_account/deliveries/stats",
  "account": "/accounts/my_account",
  "date": "2019-02-10",
  "campaignDailyLimit": 500,
  "campaignMessagesUsed": 100,
  "campaignMessagesScheduled": 50
}

© 2021 TextUs