Skip to main content
GET
/
reports
/
mdr_usage_reports
/
sync
JavaScript
import Telnyx from 'telnyx';

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

const response = await client.reports.mdrUsageReports.fetchSync({ aggregation_type: 'PROFILE' });

console.log(response.data);
{
  "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
    ],
    "aggregation_type": "NO_AGGREGATION",
    "status": "PENDING",
    "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
start_date
string<date-time>
Example:

"2020-07-01T00:00:00-06:00"

​
end_date
string<date-time>
Example:

"2020-07-01T00:00:00-06:00"

​
aggregation_type
enum<string>
required
Available options:
NO_AGGREGATION,
PROFILE,
TAGS
Example:

"PROFILE"

​
profiles
string[]
Example:
["My profile"]

Response

Successful

​
data
object