Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Usage Reports (BETA) API

Usage data reporting across Telnyx products

Telnyx Usage Reports (BETA) API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Usage Reports (BETA). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

2 operations 2 paths 9 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Usage Reports (BETA) API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Usage Reports (BETA) 2

Usage data reporting across Telnyx products

GET
/usage_reports
Get Telnyx product usage data (BETA)
GetUsageReports 12 params → 200400500
GET
/usage_reports/options
Get Usage Reports query options (BETA)
ListUsageReportsOptions 2 params → 200400500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ErrorRecord (5 properties), PaginationData (4 properties), UsageReportsOptionsRecord (4 properties), usage-reports_RecordType (3 properties). Each schema is shown below with its type and property counts.

usage-reports_ErrorResponse
object
1 property
MetaResponse
object
1 property
usage-reports_RecordType
object
An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
3 properties
ErrorRecord
object
5 properties
UsageReportsOptionsResponse
object
An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
1 property
PaginationData
object
4 properties
SourceResponse
object
2 properties
UsageReportsResponse
object
2 properties
UsageReportsOptionsRecord
object
An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-usage-reports-beta-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API