Get Telnyx product usage data (BETA)

GET 
/usage_reports

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

Request

Query Parameters

product stringrequired

Telnyx product

Examples:

• product=wireless
• product=messaging

wireless

Example: wireless

messaging

Example: messaging

dimensions string[]required

Breakout by specified product dimensions

Examples:

• dimensions=direction&dimensions=currency&dimensions=message_type

Dimensions aggregation list

Example: dimensions=direction&dimensions=currency&dimensions=message_type

metrics string[]required

Specified product usage values

Examples:

• metrics=cost&metrics=billed_sec

Metrics aggregation list

Example: metrics=cost&metrics=billed_sec

start_date string

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

Examples:

• start_date=2024-02-01T00:00:00

Aggregate for records with timestamp starting at specified date and time.

Example: 2024-02-01T00:00:00

end_date string

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

Examples:

• end_date=2024-03-01T00:00:00

Aggregate for records with timestamp ending at specified date and time.

Example: 2024-03-01T00:00:00

date_range string

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.

Examples:

• date_range=today
• date_range=last_3_days

today - Searches for records with timestamp starting at `00:00:00` of the current day

Example: today

last_3_days - Searches for records with timestamp starting at `00:00:00` since 3 days ago

Example: last_3_days

filter string

Filter records on dimensions

Examples:

• filter[currency]=USD
• filter[direction]=inbound
• filter[country_code]=NLD

Filter currency on USD

Example: filter[currency]=USD

Filter direction on Inbound

Example: filter[direction]=inbound

Filter country code on NLD

Example: filter[country_code]=NLD

managed_accounts boolean

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

Examples:

• managed_accounts=true

Fetch aggregations for all Managed Accounts

Example:

page[number] Page[Number]

Possible values: > 1

Default value: 1

page[size] Page[Size]

Possible values: <= 5000

Default value: 20

sort string[]

Specifies the sort order for results

Examples:

• defaultOrder
• sort=created_at
• sort=-created_at

Default Order (No Sort)

Example:

Sorts search results using the `created_at` date-time in ascending order

Example: created_at

Sorts search results using the `-created_at` date-time in descending order

Example: -created_at

format string

Possible values: [csv, json]

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

Examples:

• format=json
• format=csv

Get the response in JSON format

Example: json

Get the response in CSV format

Example: csv

Header Parameters

Telnyx-Auth-Rev2 string

Responses

200: Successful

application/json

• Schema
• Example (from schema)

Schema

meta

object

total_pages integer

Total number of pages.

total_results integer

Total number of results.

page_number integer

Selected page number.

page_size integer

Records per single page

data object[]

{
  "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"
    }
  ]
}

text/csv

• Schema

Schema

string

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified 5-digit integer

title string

a short, human-readable summary of the problem, with NO punctuation, that SHOULD NOT CHANGE from occurrence to occurrence of the problem, except for purposes of localization

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

pointer string

A JSON Pointer [RFC6901] to the associated entity in the request document

parameter string

a string indicating which URI query parameter caused the error

meta

object

url string

This should likely be a URL to the relevant documentation

]

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}

500: Internal Server Error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified 5-digit integer

title string

a short, human-readable summary of the problem, with NO punctuation, that SHOULD NOT CHANGE from occurrence to occurrence of the problem, except for purposes of localization

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

pointer string

A JSON Pointer [RFC6901] to the associated entity in the request document

parameter string

a string indicating which URI query parameter caused the error

meta

object

url string

This should likely be a URL to the relevant documentation

]

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}

Loading...