Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Usage

API reference descriptions are provided in English to preserve the exact published contract.

Get usage grouped by account dimension

GET/v1/accounts/{AC}/usage

usage.listSDK operation getV1AccountsByAcUsage

Required scope: usage:read.

Parameters

  • groupByenumquery

    daysendercategorysubaccount

  • fromstring (date)query
  • tostring (date)query

Get API request usage by route family

GET/v1/accounts/{AC}/usage/api

usage.api.listSDK operation getV1AccountsByAcUsageApi

Request counts, rate-limited counts and latency by route family and status class. Defaults to all authenticated traffic, including browser sessions. Set traffic=api_key for integration traffic only, aggregated from retained request facts.

Required scope: usage:read.

Parameters

  • hoursinteger (1–168)query
  • trafficenumquery

    api_keyall

Get API consumption by credential, endpoint and rate-limit scope

GET/v1/accounts/{AC}/usage/api-consumption

usage.apiConsumption.listSDK operation getV1AccountsByAcUsageApiConsumption

developer view. Aggregated from the retained request facts, so consumption is attributable to the API key that spent it, to the route template it was spent on, and a 429 to the RateLimit-Policy scope that refused it.

Required scope: usage:read.

Parameters

  • hoursinteger (1–168)query
  • trafficenumquery

    api_keyall

Get plan and Meta limits with utilisation

GET/v1/accounts/{AC}/usage/limits

usage.limits.listSDK operation getV1AccountsByAcUsageLimits

Required scope: usage:read.