v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Usage Reports (BETA)

Get Telnyx product usage data (BETA)

Get Telnyx usage data by product, broken out by the specified dimensions

get/usage_reports

Query parameters

productstring required

Telnyx product

dimensionsstring[] required

Breakout by specified product dimensions

metricsstring[] required

Specified product usage values

start_datestring

The start date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ

end_datestring

The end date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ

date_rangestring

A more user-friendly way to specify the timespan you want to filter by. More options can be found in the Telnyx API Reference docs.

filterstring

Filter records on dimensions

managed_accountsboolean

Return the aggregations for all Managed Accounts under the user making the request.

sortstring[]

Specifies the sort order for results

format'csv' | 'json'

Specify the response format (csv or json). JSON is returned by default, even if not specified.

page[number]integer

page[size]integer

Headers

authorization_bearerstring

Authenticates the request with your Telnyx API V2 KEY

Bearer token used to authenticate the request.

Response

Successful

dataobject[]

Example response

{
  "meta": {
    "total_pages": 5,
    "total_results": 100,
    "page_number": 1,
    "page_size": 20
  },
  "data": [
    {
      "product": "messaging",
      "cost": 0.012,
      "parts": 12,
      "count": 8,
      "customer_carrier_fee": 0,
      "product_name": "long_code",
      "country_iso": "LC",
      "direction": "outbound"
    },
    {
      "product": "messaging",
      "cost": 0.021,
      "parts": 21,
      "count": 12,
      "customer_carrier_fee": 0,
      "product_name": "long_code",
      "country_iso": "MP",
      "direction": "outbound"
    }
  ]
}