Telco Data Usage Reports

Submit telco data usage report

Changed on

Submits a new telco data (number lookup) usage report request. The report is generated asynchronously; retrieve it by its identifier once ready.

post/legacy_reporting/usage_reports/number_lookup

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/legacy_reporting/usage_reports/number_lookup
  • Auth: HTTP bearer

Request body */*

startDatestring date

Start date for the usage report

endDatestring date

End date for the usage report

aggregationType'ALL' | 'BY_ORGANIZATION_MEMBER'

Type of aggregation for the report

managedAccountsstring[]

List of managed accounts to include in the report

Example request

{
  "startDate": "2025-02-10",
  "endDate": "2025-02-10",
  "aggregationType": "ALL",
  "managedAccounts": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ]
}

Response

Successfully submitted telco data usage report

Example response

{
  "data": {
    "id": "9783f4d7-0bfc-427a-9d6b-bc659ad16e5b",
    "start_date": "2025-11-01",
    "end_date": "2025-12-01",
    "aggregation_type": "ALL",
    "status": "COMPLETE",
    "report_url": "https://portal-cdrs-usage.s3.amazonaws.com/telco_data_usage_report_2025-12-02.csv",
    "created_at": "2025-12-02T20:20:57.196925Z",
    "updated_at": "2025-12-02T20:21:08.237091Z",
    "managed_accounts": [],
    "result": [
      {
        "user_id": "d37bdd47-f301-42ec-b2ad-5a0465bfb632",
        "aggregations": [
          {
            "type": "CNAM",
            "total_dips": 3,
            "total_cost": 0.009,
            "currency": "USD"
          }
        ],
        "record_type": "TelcoDataUsageRecord"
      }
    ],
    "record_type": "TelcoDataUsageReport"
  }
}

Changes