Accounts

Get usage summary for a billing period

Message counts, billed cost and segments for the period (defaults to the current calendar month), plus live delivery health: "delivery" { liveOutbound, delivered, failed, undelivered, pending, failureRatePct } over live outbound messages (auto-replies excluded) and "byNumber", the same figures per sending number, busiest first. A rising failureRatePct usually means wrong numbers, landlines, or a script retrying one recipient; above 10 % over your last 50 sends you are emailed and account.delivery_warning fires.

Requires account:r.

get/v1/accounts/{id}/usage

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/accounts/{id}/usage
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Query parameters

fromstring date

Start date (YYYY-MM-DD)

tostring date

End date (YYYY-MM-DD)

Response

Usage for the period. Field names are camelCase, unlike the rest of the API.

totalMessagesinteger required

Every message in the period, inbound and test-mode included.

testMessagesinteger required

How many of totalMessages were test-mode simulations, billed nothing.

outboundMessagesinteger required
inboundMessagesinteger required
totalCostCentsinteger required

What LIVE messages cost, in CAD cents.

segmentCountinteger required

LIVE SMS parts billed.

Changes

No recorded changes to this operation across all 1 revision of this API.