Fetch all Messaging usage reports
Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
GET
JavaScript
JavaScript
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check out our upcoming events and meetups! View events →
Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
console.log(mdrUsageReport.id);
}{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"connections": [
123
],
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"result": [
{
"cost": "0",
"direction": "outbound",
"product": "outbound",
"connection": "all",
"received": "0",
"delivered": "0",
"currency": "USD",
"parts": "0",
"sent": "0",
"profile_id": "All",
"tags": "All",
"message_type": "SMS",
"tn_type": "TF",
"carrier_passthrough_fee": "0"
}
],
"created_at": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Show child attributes
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
console.log(mdrUsageReport.id);
}{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"connections": [
123
],
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"result": [
{
"cost": "0",
"direction": "outbound",
"product": "outbound",
"connection": "all",
"received": "0",
"delivered": "0",
"currency": "USD",
"parts": "0",
"sent": "0",
"profile_id": "All",
"tags": "All",
"message_type": "SMS",
"tn_type": "TF",
"carrier_passthrough_fee": "0"
}
],
"created_at": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}