MDR Usage Reports
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
Query parameters
start_datestring date-time
Example:2020-07-01T00:00:00-06:00
Start of the date range filter (inclusive, ISO 8601).
end_datestring date-time
Example:2020-07-01T00:00:00-06:00
End of the date range filter (inclusive, ISO 8601).
aggregation_type'NO_AGGREGATION' | 'PROFILE' | 'TAGS' required
Example:PROFILE
Type of aggregation to apply to the results.
profilesstring[]
Filter results by profile.
[ "My profile" ]
Response
Successful
Example response
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"result": [
{
"carrier_passthrough_fee": "0",
"connection": "all",
"cost": "0",
"currency": "USD",
"delivered": "0",
"direction": "outbound",
"message_type": "SMS",
"parts": "0",
"product": "outbound",
"profile_id": "All",
"received": "0",
"sent": "0",
"tags": "All",
"tn_type": "TF"
}
],
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}