{ "opencollection": "1.0.0", "info": { "name": "Telnyx Access Tokens Usage Reports (BETA) API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Usage Reports (BETA)", "type": "folder" }, "items": [ { "info": { "name": "Get Telnyx product usage data (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/usage_reports", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "product", "value": "", "type": "query", "description": "Telnyx product" }, { "name": "dimensions", "value": "", "type": "query", "description": "Breakout by specified product dimensions" }, { "name": "metrics", "value": "", "type": "query", "description": "Specified product usage values" }, { "name": "start_date", "value": "", "type": "query", "description": "The start date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ" }, { "name": "end_date", "value": "", "type": "query", "description": "The end date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ" }, { "name": "date_range", "value": "", "type": "query", "description": "A more user-friendly way to specify the timespan you want to filter by. More options can be found in the Telnyx API Reference docs." }, { "name": "filter", "value": "", "type": "query", "description": "Filter records on dimensions" }, { "name": "managed_accounts", "value": "", "type": "query", "description": "Return the aggregations for all Managed Accounts under the user making the request." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results" }, { "name": "format", "value": "", "type": "query", "description": "Specify the response format (csv or json). JSON is returned by default, even if not specified." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Telnyx usage data by product, broken out by the specified dimensions" }, { "info": { "name": "Get Usage Reports query options (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/usage_reports/options", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "product", "value": "", "type": "query", "description": "Options (dimensions and metrics) for a given product. If none specified, all products will be returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions" } ] } ], "bundled": true }