Get Usage Reports query options (BETA)

GET 
/usage_reports/options

Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions

Request

Query Parameters

product string

Options (dimensions and metrics) for a given product. If none specified, all products will be returned.

Examples:

• product=wireless

Specify a product if you know what you're looking for

Example: wireless

Header Parameters

Authorization: Bearer <TOKEN> string

Responses

200: Successful

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Collection of product description

Array [

product string

Telnyx Product

product_dimensions string[]

Telnyx Product Dimensions

product_metrics string[]

Telnyx Product Metrics

record_types

object[]

Subproducts if applicable

Array [

record_type string

Telnyx Product type

product_dimensions string[]

Telnyx Product Dimensions

product_metrics string[]

Telnyx Product Metrics

]

Subproducts if applicable

]

Collection of product description

{
  "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": "null"
    }
  ]
}

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified 5-digit integer

title string

a short, human-readable summary of the problem, with NO punctuation, that SHOULD NOT CHANGE from occurrence to occurrence of the problem, except for purposes of localization

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

pointer string

A JSON Pointer [RFC6901] to the associated entity in the request document

parameter string

a string indicating which URI query parameter caused the error

meta

object

url string

This should likely be a URL to the relevant documentation

]

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}

500: Internal Server Error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified 5-digit integer

title string

a short, human-readable summary of the problem, with NO punctuation, that SHOULD NOT CHANGE from occurrence to occurrence of the problem, except for purposes of localization

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

pointer string

A JSON Pointer [RFC6901] to the associated entity in the request document

parameter string

a string indicating which URI query parameter caused the error

meta

object

url string

This should likely be a URL to the relevant documentation

]

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/usage_reports/options' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 400
• 500

---

{
  "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": "null"
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Metrics invalid values",
      "detail": "Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.",
      "source": {
        "pointer": "/title",
        "parameter": "metrics"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10001"
      }
    }
  ]
}