Skip to main content
POST
/
legacy_reporting
/
usage_reports
/
number_lookup
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const numberLookup = await client.legacy.reporting.usageReports.numberLookup.create();

console.log(numberLookup.data);
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

*/*

Telco data usage request data

​
startDate
string<date>

Start date for the usage report

Example:

"2025-02-10"

​
endDate
string<date>

End date for the usage report

Example:

"2025-02-10"

​
aggregationType
enum<string>

Type of aggregation for the report

Available options:
ALL,
BY_ORGANIZATION_MEMBER
Example:

"ALL"

​
managedAccounts
string[]

List of managed accounts to include in the report

Example:
[
  "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]

Response

Successfully submitted telco data usage report

​
data
object

Telco data usage report response