Usage Reports (BETA)
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
Query parameters
productstring
Options (dimensions and metrics) for a given product. If none specified, all products will be returned.
Headers
authorization_bearerstring
Authenticates the request with your Telnyx API V2 KEY
Bearer token used to authenticate the request.
Response
Successful
Example response
{
"data": [
{
"product": "wireless",
"product_dimensions": [
"mnc",
"mcc",
"sim_card_id",
"sim_group_name"
],
"product_metrics": [
"uplink_data_bytes",
"downlink_data",
"downlink_data_bytes",
"uplink_data",
"data_cost"
],
"record_types": [
{
"product_dimensions": [
"direction",
"currency",
"message_type"
],
"product_metrics": [
"cost",
"billed_sec"
],
"record_type": "conversation_event"
}
]
}
]
}