Query Cellular Metrics (v2.0)

Get cellular metrics like Signal-to Noise Ratio (SNR) and cellular bandwidth usage.

application/json

Request Body

Query request for getting cellularmetrics

end_time date required
The end time to get the cellular metrics. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.
filter CellularmetricsFilter required
Filters according to the specifications.
apn string[] required
The APN name that provides access to the mobile broadband network.
carrier string[] required
The name of the carrier.
cellular_module string[] required
The module of the cellular.
direction string required
Possible values: [Ingress, Egress]
The direction of the traffic.
element string[] required
The element.
site string[] required
The site.
interval string required
Possible values: [TEN_SEC, ONE_MIN, FIVE_MIN, ONE_HOUR, ONE_DAY]
The interval time.
max_datapoints int32 required
The max data points.
metrics Metrics[] required
The details of the cellular metrics. Metrics need to specified according to 2.1 specifications. Invalid metrics will be ignored and the result will not include them.
Array [
series Series[] required
Information on the series schema.
Array [
data Data[] required
Data
Array [
datapoints Datapoints[] required
Datapoints
Array [
duration date-time required
The date and time of the series.
filter_property_id string required
The filter property ID.
links string[] required
Links
sites string[] required
The sites.
value number required
The values of the filter.
]
statistics object required
Statistics
]
interval string required
The interval time.
name string required
The name.
unit string required
Unit
view object required
View the active series details.
]
]
name string required
The name of the cellular metric. Maz size = 128.
start_time date required
The start time to get the cellular metrics. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.
view View required
The individual and summary views.
individual string required
Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, None]
The individual view values.
summary boolean required
The summary of the view.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

metrics Metrics[] required
Metrics
Array [
series Series[] required
Information on the series schema.
Array [
data Data[] required
Data
Array [
datapoints Datapoints[] required
Datapoints
Array [
duration date-time required
The date and time of the series.
filter_property_id string required
The filter property ID.
links string[] required
Links
sites string[] required
The sites.
value number required
The values of the filter.
]
statistics object required
Statistics
]
interval string required
The interval time.
name string required
The name.
unit string required
Unit
view object required
View the active series details.
]
]

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2023-05-27T04:01:43.702Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    }
  ]
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

_error ErrorResponse[]
Array [
code string
message string
]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "METRIC_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "UNSUPPORTED_FILTER_IN_VERSION"
      },
      {
        "code": "UNSUPPORTED_FILTER_FOR_METRIC"
      },
      {
        "code": "MISSING_INTERFACE_FILTER_PROPERTY"
      },
      {
        "code": "MISSING_ELEMENT_FILTER_PROPERTY"
      },
      {
        "code": "UNSUPPORTED_DIRECTION_FILTER"
      },
      {
        "code": "DIRECTION_FILTER_EMPTY"
      },
      {
        "code": "DIRECTION_VIEW_NOT_SUPPORTED"
      },
      {
        "code": "MAX_DATAPOINTS_END_TIME"
      },
      {
        "code": "VERSION_NOT_SUPPORTED"
      },
      {
        "code": "METRIC_STATISTICS_NOT_SUPPORTED"
      }
    ]
  }
}

Internal Server Error

application/json

Schema
Example (from schema)
Example

Schema

_error ErrorResponse[]
Array [
code string
message string
]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "SERVER_ERROR"
      }
    ]
  }
}

Query Cellular Metrics (v2.0)​

Query Cellular Metrics (v2.0)