CDR Usage Reports

Create a new legacy usage V2 CDR report request

Changed on

Creates a new legacy usage V2 CDR report request with the specified filters

post/legacy/reporting/usage_reports/voice

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice
  • Auth: HTTP bearer

Request body */*

start_timestring date-time required

Start time in ISO format

end_timestring date-time required

End time in ISO format

aggregation_typeinteger

Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3

connectionsinteger[]

List of connections to filter by

product_breakdowninteger

Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID vs Toll-free per Country = 3

managed_accountsstring[]

List of managed accounts to include

select_all_managed_accountsboolean

Whether to select all managed accounts

Example request

{
  "start_time": "2024-02-01T00:00:00Z",
  "end_time": "2024-02-01T00:00:00Z",
  "connections": [
    123,
    456
  ],
  "managed_accounts": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ]
}

Response

V2 legacy CDR usage report request created successfully

Example response

{
  "data": {
    "start_time": "2018-02-02T22:25:27.521Z",
    "end_time": "2018-02-02T22:25:27.521Z",
    "connections": [
      "1234567890",
      "9876543210"
    ],
    "report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "record_type": "cdr_usage_report"
  }
}

Changes