team-telnyx/ai / providers/claude/plugins/telnyx-platform/skills/telnyx-twilio-migration
telnyx-twilio-migration
UnverifiedMigrate from Twilio to Telnyx. Orchestrates a complete 6-phase migration: discovery, planning, setup, code migration, validation, and cleanup. Covers voice (TwiML to TeXML, Call Control API), messaging, WebRTC, SIP trunking, verify, fax, video, IoT, number lookup, and porting. Includes automated scanners, validation scripts, and integration tests.
sdk-reference/javascript/account-reports.md
View on GitHub<!-- SDK reference: telnyx-account-reports-javascript -->
# Telnyx Account Reports - JavaScript
## Installation
```bash
npm install telnyx@6.74.2
```
## Setup
```javascript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
publicKey: process.env['TELNYX_PUBLIC_KEY'], // Required for client.webhooks.unwrap() (webhook verification)
});
```
All examples below assume `client` is already initialized as shown above.
## Error Handling
All API calls can fail with network errors, rate limits (429), validation errors (422),
or authentication errors (401). Always handle errors in production code:
```javascript
try {
const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
if (err instanceof Telnyx.APIConnectionError) {
console.error('Network error — check connectivity and retry');
} else if (err instanceof Telnyx.RateLimitError) {
// 429: rate limited — wait, then retry the request (bounded exponential backoff)
const retryAfter = err.headers?.['retry-after'] || 1;
await new Promise(r => setTimeout(r, retryAfter * 1000));
// ...retry the call here (give up after a few attempts)
} else if (err instanceof Telnyx.APIError) {
console.error(`API error ${err.status}: ${err.message}`);
if (err.status === 422) {
console.error('Validation error — check required fields and formats');
}
}
throw err; // Re-throw: a failed request must never look like success to the caller
}
```
Common error codes: `401` invalid API key, `403` insufficient permissions,
`404` resource not found, `422` validation error (check field formats),
`429` rate limited (retry with exponential backoff).
## Important Notes
- **Pagination:** List methods return an auto-paginating iterator. Use `for await (const item of result) { ... }` to iterate through all pages automatically.
## List call events
Filters call events by given filter parameters. Events are ordered by `occurred_at`. If filter for `leg_id` or `application_session_id` is not present, it only filters events from the last 24 hours.
`GET /call_events`
```javascript
// Automatically fetches more pages as needed.
for await (const callEventListResponse of client.callEvents.list()) {
console.log(callEventListResponse.call_leg_id);
}
```
Returns: `call_leg_id` (string), `call_session_id` (string), `event_timestamp` (string), `metadata` (object), `name` (string), `record_type` (enum: call_event), `type` (enum: command, webhook)
## Create a ledger billing group report
Create a ledger billing group report, which aggregates ledger activity by billing group.
`POST /ledger_billing_group_reports`
Optional: `month` (integer), `year` (integer)
```javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.create({
month: 10,
year: 2019,
});
console.log(ledgerBillingGroupReport.data);
```
Returns: `created_at` (date-time), `id` (uuid), `organization_id` (uuid), `record_type` (enum: ledger_billing_group_report), `report_url` (uri), `status` (enum: pending, complete, failed, deleted), `updated_at` (date-time)
## Get a ledger billing group report
Retrieve the details and status of a previously created ledger billing group report.
`GET /ledger_billing_group_reports/{id}`
```javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.retrieve(
'f5586561-8ff0-4291-a0ac-84fe544797bd',
);
console.log(ledgerBillingGroupReport.data);
```
Returns: `created_at` (date-time), `id` (uuid), `organization_id` (uuid), `record_type` (enum: ledger_billing_group_report), `report_url` (uri), `status` (enum: pending, complete, failed, deleted), `updated_at` (date-time)
## Get all MDR detailed report requests
Retrieves all MDR detailed report requests for the authenticated user
`GET /legacy/reporting/batch_detail_records/messaging`
```javascript
const messagings = await client.legacy.reporting.batchDetailRecords.messaging.list();
console.log(messagings.data);
```
Returns: `connections` (array[integer]), `created_at` (date-time), `directions` (array[string]), `end_date` (date-time), `filters` (array[object]), `id` (uuid), `profiles` (array[string]), `record_type` (string), `record_types` (array[string]), `report_name` (string), `report_url` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Create a new MDR detailed report request
Creates a new MDR detailed report request with the specified filters
`POST /legacy/reporting/batch_detail_records/messaging` — Required: `start_time`, `end_time`
Optional: `connections` (array[integer]), `directions` (array[integer]), `filters` (array[object]), `include_message_body` (boolean), `managed_accounts` (array[string]), `profiles` (array[string]), `record_types` (array[integer]), `report_name` (string), `select_all_managed_accounts` (boolean), `timezone` (string)
```javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.create({
end_time: '2024-02-12T23:59:59Z',
start_time: '2024-02-01T00:00:00Z',
});
console.log(messaging.data);
```
Returns: `connections` (array[integer]), `created_at` (date-time), `directions` (array[string]), `end_date` (date-time), `filters` (array[object]), `id` (uuid), `profiles` (array[string]), `record_type` (string), `record_types` (array[string]), `report_name` (string), `report_url` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Get a specific MDR detailed report request
Retrieves a specific MDR detailed report request by ID
`GET /legacy/reporting/batch_detail_records/messaging/{id}`
```javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(messaging.data);
```
Returns: `connections` (array[integer]), `created_at` (date-time), `directions` (array[string]), `end_date` (date-time), `filters` (array[object]), `id` (uuid), `profiles` (array[string]), `record_type` (string), `record_types` (array[string]), `report_name` (string), `report_url` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Delete a MDR detailed report request
Deletes a specific MDR detailed report request by ID
`DELETE /legacy/reporting/batch_detail_records/messaging/{id}`
```javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.delete(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(messaging.data);
```
Returns: `connections` (array[integer]), `created_at` (date-time), `directions` (array[string]), `end_date` (date-time), `filters` (array[object]), `id` (uuid), `profiles` (array[string]), `record_type` (string), `record_types` (array[string]), `report_name` (string), `report_url` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Get all CDR report requests
Retrieves all CDR report requests for the authenticated user
`GET /legacy/reporting/batch_detail_records/voice`
```javascript
const voices = await client.legacy.reporting.batchDetailRecords.voice.list();
console.log(voices.data);
```
Returns: `call_types` (array[integer]), `connections` (array[integer]), `created_at` (string), `end_time` (string), `filters` (array[object]), `id` (string), `managed_accounts` (array[string]), `record_type` (string), `record_types` (array[integer]), `report_name` (string), `report_url` (string), `retry` (int32), `source` (string), `start_time` (string), `status` (int32), `timezone` (string), `updated_at` (string)
## Create a new CDR report request
Creates a new CDR report request with the specified filters
`POST /legacy/reporting/batch_detail_records/voice` — Required: `start_time`, `end_time`
Optional: `call_types` (array[integer]), `connections` (array[integer]), `fields` (array[string]), `filters` (array[object]), `include_all_metadata` (boolean), `managed_accounts` (array[string]), `record_types` (array[integer]), `report_name` (string), `select_all_managed_accounts` (boolean), `source` (string), `timezone` (string)
```javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.create({
end_time: '2024-02-12T23:59:59Z',
start_time: '2024-02-01T00:00:00Z',
});
console.log(voice.data);
```
Returns: `call_types` (array[integer]), `connections` (array[integer]), `created_at` (string), `end_time` (string), `filters` (array[object]), `id` (string), `managed_accounts` (array[string]), `record_type` (string), `record_types` (array[integer]), `report_name` (string), `report_url` (string), `retry` (int32), `source` (string), `start_time` (string), `status` (int32), `timezone` (string), `updated_at` (string)
## Get available CDR report fields
Retrieves all available fields that can be used in CDR reports
`GET /legacy/reporting/batch_detail_records/voice/fields`
```javascript
const response = await client.legacy.reporting.batchDetailRecords.voice.retrieveFields();
console.log(response.Billing);
```
Returns: `Billing` (array[string]), `Interaction Data` (array[string]), `Number Information` (array[string]), `Telephony Data` (array[string])
## Get a specific CDR report request
Retrieves a specific CDR report request by ID
`GET /legacy/reporting/batch_detail_records/voice/{id}`
```javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(voice.data);
```
Returns: `call_types` (array[integer]), `connections` (array[integer]), `created_at` (string), `end_time` (string), `filters` (array[object]), `id` (string), `managed_accounts` (array[string]), `record_type` (string), `record_types` (array[integer]), `report_name` (string), `report_url` (string), `retry` (int32), `source` (string), `start_time` (string), `status` (int32), `timezone` (string), `updated_at` (string)
## Delete a CDR report request
Deletes a specific CDR report request by ID
`DELETE /legacy/reporting/batch_detail_records/voice/{id}`
```javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.delete(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(voice.data);
```
Returns: `call_types` (array[integer]), `connections` (array[integer]), `created_at` (string), `end_time` (string), `filters` (array[object]), `id` (string), `managed_accounts` (array[string]), `record_type` (string), `record_types` (array[integer]), `report_name` (string), `report_url` (string), `retry` (int32), `source` (string), `start_time` (string), `status` (int32), `timezone` (string), `updated_at` (string)
## List MDR usage reports
Fetch all previous requests for MDR usage reports.
`GET /legacy/reporting/usage_reports/messaging`
```javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.messaging.list()) {
console.log(mdrUsageReportResponseLegacy.id);
}
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `profiles` (array[string]), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Create a new legacy usage V2 MDR report request
Creates a new legacy usage V2 MDR report request with the specified filters
`POST /legacy/reporting/usage_reports/messaging`
```javascript
const messaging = await client.legacy.reporting.usageReports.messaging.create({
aggregation_type: 0,
});
console.log(messaging.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `profiles` (array[string]), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Get an MDR usage report
Returns a single MDR (Message Detail Record) usage report by its identifier, including its parameters and current status.
`GET /legacy/reporting/usage_reports/messaging/{id}`
```javascript
const messaging = await client.legacy.reporting.usageReports.messaging.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(messaging.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `profiles` (array[string]), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Delete a V2 legacy usage MDR report request
Deletes a specific V2 legacy usage MDR report request by ID
`DELETE /legacy/reporting/usage_reports/messaging/{id}`
```javascript
const messaging = await client.legacy.reporting.usageReports.messaging.delete(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(messaging.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `profiles` (array[string]), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## List telco data usage reports
Retrieve a paginated list of telco data usage reports
`GET /legacy/reporting/usage_reports/number_lookup`
```javascript
const numberLookups = await client.legacy.reporting.usageReports.numberLookup.list();
console.log(numberLookups.data);
```
Returns: `aggregation_type` (string), `created_at` (date-time), `end_date` (date), `id` (uuid), `managed_accounts` (array[string]), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date), `status` (string), `updated_at` (date-time)
## Submit telco data usage report
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`
```javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.create();
console.log(numberLookup.data);
```
Returns: `aggregation_type` (string), `created_at` (date-time), `end_date` (date), `id` (uuid), `managed_accounts` (array[string]), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date), `status` (string), `updated_at` (date-time)
## Get telco data usage report by ID
Retrieve a specific telco data usage report by its ID
`GET /legacy/reporting/usage_reports/number_lookup/{id}`
```javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('550e8400-e29b-41d4-a716-446655440000');
console.log(numberLookup.data);
```
Returns: `aggregation_type` (string), `created_at` (date-time), `end_date` (date), `id` (uuid), `managed_accounts` (array[string]), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date), `status` (string), `updated_at` (date-time)
## Delete telco data usage report
Delete a specific telco data usage report by its ID
`DELETE /legacy/reporting/usage_reports/number_lookup/{id}`
```javascript
await client.legacy.reporting.usageReports.numberLookup.delete('550e8400-e29b-41d4-a716-446655440000');
```
## List CDR usage reports
Fetch all previous requests for cdr usage reports.
`GET /legacy/reporting/usage_reports/voice`
```javascript
// Automatically fetches more pages as needed.
for await (const cdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.voice.list()) {
console.log(cdrUsageReportResponseLegacy.id);
}
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `product_breakdown` (int32), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Create a new legacy usage V2 CDR report request
Creates a new legacy usage V2 CDR report request with the specified filters
`POST /legacy/reporting/usage_reports/voice`
```javascript
const voice = await client.legacy.reporting.usageReports.voice.create({
end_time: '2024-02-01T00:00:00Z',
start_time: '2024-02-01T00:00:00Z',
});
console.log(voice.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `product_breakdown` (int32), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Get a CDR usage report
Returns a single CDR (Call Detail Record) usage report by its identifier, including its parameters and current status.
`GET /legacy/reporting/usage_reports/voice/{id}`
```javascript
const voice = await client.legacy.reporting.usageReports.voice.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(voice.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `product_breakdown` (int32), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## Delete a V2 legacy usage CDR report request
Deletes a specific V2 legacy usage CDR report request by ID
`DELETE /legacy/reporting/usage_reports/voice/{id}`
```javascript
const voice = await client.legacy.reporting.usageReports.voice.delete(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(voice.data);
```
Returns: `aggregation_type` (int32), `connections` (array[string]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `product_breakdown` (int32), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (int32), `updated_at` (date-time)
## List CSV downloads
Returns CSV export jobs created for account phone numbers, including each export's current status and pagination metadata.
`GET /phone_numbers/csv_downloads`
```javascript
// Automatically fetches more pages as needed.
for await (const csvDownload of client.phoneNumbers.csvDownloads.list()) {
console.log(csvDownload.id);
}
```
Returns: `id` (string), `record_type` (string), `status` (enum: pending, complete, failed, expired), `url` (string)
## Create a CSV download
Starts generation of a CSV export for phone numbers matching the supplied filters. The `csv_format` parameter selects the output format, and the response contains the resulting download record.
`POST /phone_numbers/csv_downloads`
```javascript
const csvDownload = await client.phoneNumbers.csvDownloads.create();
console.log(csvDownload.data);
```
Returns: `id` (string), `record_type` (string), `status` (enum: pending, complete, failed, expired), `url` (string)
## Retrieve a CSV download
Returns the current status and download details for the CSV export identified by `id`.
`GET /phone_numbers/csv_downloads/{id}`
```javascript
const csvDownload = await client.phoneNumbers.csvDownloads.retrieve('550e8400-e29b-41d4-a716-446655440000');
console.log(csvDownload.data);
```
Returns: `id` (string), `record_type` (string), `status` (enum: pending, complete, failed, expired), `url` (string)
## Generates and fetches CDR Usage Reports
Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
`GET /reports/cdr_usage_reports/sync`
```javascript
const response = await client.reports.cdrUsageReports.fetchSync({
aggregation_type: 'NO_AGGREGATION',
product_breakdown: 'NO_BREAKDOWN',
});
console.log(response.data);
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, CONNECTION, TAG, BILLING_GROUP), `connections` (array[integer]), `created_at` (date-time), `end_time` (date-time), `id` (uuid), `product_breakdown` (enum: NO_BREAKDOWN, DID_VS_TOLL_FREE, COUNTRY, DID_VS_TOLL_FREE_PER_COUNTRY), `record_type` (string), `report_url` (string), `result` (object), `start_time` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Fetch all Messaging usage reports
Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
`GET /reports/mdr_usage_reports`
```javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
console.log(mdrUsageReport.id);
}
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, PROFILE, TAGS), `connections` (array[integer]), `created_at` (date-time), `end_date` (date-time), `id` (uuid), `profiles` (string), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Create MDR Usage Report
Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.
`POST /reports/mdr_usage_reports`
```javascript
const mdrUsageReport = await client.reports.mdrUsageReports.create({
aggregation_type: 'NO_AGGREGATION',
end_date: '2020-07-01T00:00:00-06:00',
start_date: '2020-07-01T00:00:00-06:00',
});
console.log(mdrUsageReport.data);
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, PROFILE, TAGS), `connections` (array[integer]), `created_at` (date-time), `end_date` (date-time), `id` (uuid), `profiles` (string), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Generate and fetch MDR Usage Report
Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
`GET /reports/mdr_usage_reports/sync`
```javascript
const response = await client.reports.mdrUsageReports.fetchSync({ aggregation_type: 'PROFILE' });
console.log(response.data);
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, PROFILE, TAGS), `connections` (array[integer]), `created_at` (date-time), `end_date` (date-time), `id` (uuid), `profiles` (string), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Retrieve messaging report
Fetch a single messaging usage report by id
`GET /reports/mdr_usage_reports/{id}`
```javascript
const mdrUsageReport = await client.reports.mdrUsageReports.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(mdrUsageReport.data);
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, PROFILE, TAGS), `connections` (array[integer]), `created_at` (date-time), `end_date` (date-time), `id` (uuid), `profiles` (string), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Delete MDR Usage Report
Permanently deletes the specified messaging usage report by its identifier.
`DELETE /reports/mdr_usage_reports/{id}`
```javascript
const mdrUsageReport = await client.reports.mdrUsageReports.delete(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);
console.log(mdrUsageReport.data);
```
Returns: `aggregation_type` (enum: NO_AGGREGATION, PROFILE, TAGS), `connections` (array[integer]), `created_at` (date-time), `end_date` (date-time), `id` (uuid), `profiles` (string), `record_type` (string), `report_url` (string), `result` (array[object]), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED), `updated_at` (date-time)
## Fetch all Mdr records
Returns message detail records (MDRs) matching the provided criteria, such as date range, direction, status, and message type.
`GET /reports/mdrs`
```javascript
const response = await client.reports.listMdrs();
console.log(response.data);
```
Returns: `cld` (string), `cli` (string), `cost` (string), `created_at` (date-time), `currency` (enum: AUD, CAD, EUR, GBP, USD), `direction` (string), `id` (string), `message_type` (enum: SMS, MMS), `parts` (number), `profile_name` (string), `rate` (string), `record_type` (string), `status` (enum: GW_TIMEOUT, DELIVERED, DLR_UNCONFIRMED, DLR_TIMEOUT, RECEIVED, GW_REJECT, FAILED)
## Fetches all Wdr records
Returns wireless detail records (WDRs) matching the provided criteria, such as date range, SIM card, IMSI, or phone number, with pagination and sorting.
`GET /reports/wdrs`
```javascript
// Automatically fetches more pages as needed.
for await (const reportListWdrsResponse of client.reports.listWdrs()) {
console.log(reportListWdrsResponse.id);
}
```
Returns: `cost` (object), `created_at` (date-time), `downlink_data` (object), `duration_seconds` (number), `id` (string), `imsi` (string), `mcc` (string), `mnc` (string), `phone_number` (string), `rate` (object), `record_type` (string), `sim_card_id` (string), `sim_group_id` (string), `sim_group_name` (string), `uplink_data` (object)
## Get metadata overview
Returns all available record types and supported query parameters for session analysis.
`GET /session_analysis/metadata`
```javascript
const metadata = await client.sessionAnalysis.metadata.retrieve();
console.log(metadata.meta);
```
Returns: `meta` (object), `query_parameters` (object), `record_types` (array[object])
## Get record type metadata
Returns detailed metadata for a specific record type, including relationships and examples.
`GET /session_analysis/metadata/{record_type}`
```javascript
const response = await client.sessionAnalysis.metadata.retrieveRecordType('record_type');
console.log(response.aliases);
```
Returns: `aliases` (array[string]), `child_relationships` (array[object]), `event` (string), `examples` (object), `meta` (object), `parent_relationships` (array[object]), `product` (string), `record_type` (string)
## Get session analysis
Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages.
`GET /session_analysis/{record_type}/{event_id}`
```javascript
const sessionAnalysis = await client.sessionAnalysis.retrieve(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ record_type: 'record_type' },
);
console.log(sessionAnalysis.session_id);
```
Returns: `cost` (object), `meta` (object), `root` (object), `session_id` (string)
## Get Telnyx product usage data (BETA)
Get Telnyx usage data by product, broken out by the specified dimensions
`GET /usage_reports`
```javascript
// Automatically fetches more pages as needed.
for await (const usageReportListResponse of client.usageReports.list({
dimensions: ['string'],
metrics: ['string'],
product: 'wireless',
})) {
console.log(usageReportListResponse);
}
```
Returns: `data` (array[object]), `meta` (object)
## Get Usage Reports query options (BETA)
Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions
`GET /usage_reports/options`
```javascript
const response = await client.usageReports.getOptions();
console.log(response.data);
```
Returns: `product` (string), `product_dimensions` (array[string]), `product_metrics` (array[string]), `record_types` (array[object])
## Get all Wireless Detail Records (WDRs) Reports
Returns the WDR Reports that match the given parameters.
`GET /wireless/detail_records_reports`
```javascript
const detailRecordsReports = await client.wireless.detailRecordsReports.list();
console.log(detailRecordsReports.data);
```
Returns: `created_at` (string), `end_time` (string), `id` (uuid), `record_type` (string), `report_url` (string), `start_time` (string), `status` (enum: pending, complete, failed, deleted), `updated_at` (string)
## Create a Wireless Detail Records (WDRs) Report
Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
`POST /wireless/detail_records_reports`
Optional: `end_time` (string), `start_time` (string)
```javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.create();
console.log(detailRecordsReport.data);
```
Returns: `created_at` (string), `end_time` (string), `id` (uuid), `record_type` (string), `report_url` (string), `start_time` (string), `status` (enum: pending, complete, failed, deleted), `updated_at` (string)
## Get a Wireless Detail Record (WDR) Report
Returns a single Wireless Detail Record (WDR) report by its identifier, including its parameters and current status.
`GET /wireless/detail_records_reports/{id}`
```javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(detailRecordsReport.data);
```
Returns: `created_at` (string), `end_time` (string), `id` (uuid), `record_type` (string), `report_url` (string), `start_time` (string), `status` (enum: pending, complete, failed, deleted), `updated_at` (string)
## Delete a Wireless Detail Record (WDR) Report
Permanently deletes the specified Wireless Detail Record (WDR) report.
`DELETE /wireless/detail_records_reports/{id}`
```javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.delete(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(detailRecordsReport.data);
```
Returns: `created_at` (string), `end_time` (string), `id` (uuid), `record_type` (string), `report_url` (string), `start_time` (string), `status` (enum: pending, complete, failed, deleted), `updated_at` (string)
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |