Skip to main content

List all usage reports

GET 
/reporting/usage_reports

Returns a list of your usage reports.

Request ​

Query Parameters

    page integer

    Default value: 1

    Page number of results to load

    per_page integer

    Possible values: <= 1000

    Default value: 100

    Number of results per page

Responses ​

200: Usage Report response

Schema

  • Array [

    • id stringrequired
    start_time stringrequired

    UTC (2024-11-01T00:00:00+00:00)

    end_time stringrequired

    UTC (2024-11-01T12:23:23+00:00)

    connections string[]required

    Array of connection IDs

    aggregation_type integerrequired

    Default value: 0

    Aggregate by: All = 0, By Connections = 1

    status integerrequired

    Default value: 1

    Pending = 1, Complete = 2, Failed = 3, Expired = 4

    report_url stringrequired

    Link to report

    result objectrequired

    Report results

    created_at stringrequired
    updated_at stringrequired

  • ]

401: Unauthorized

Request samples

curl -L 'https://api.telnyx.com/reporting/usage_reports' \
-H 'Accept: application/json'

Response samples

[
  {
    "id": "string",
    "start_time": "string",
    "end_time": "string",
    "connections": [
      "string"
    ],
    "aggregation_type": 0,
    "status": 1,
    "report_url": "string",
    "result": {},
    "created_at": "string",
    "updated_at": "string"
  }
]