Skip to main content

Retrieve usage report status

GET 
/reporting/usage_reports/:id

Retrieve the status of a usage report. Response includes a link to the report once it is generated.

Request ​

Path Parameters

    id stringrequired

    ID of Usage Report to retrieve

Responses ​

200: usage_report

Schema

    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

404: Resource not found

Request samples

curl -L 'https://api.telnyx.com/reporting/usage_reports/:id' \
-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"
}