Query Cellular Metrics (v2.0)
Get cellular metrics like Signal-to Noise Ratio (SNR) and cellular bandwidth usage.
Request Body
Query request for getting cellularmetrics
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
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.
The APN name that provides access to the mobile broadband network.
The name of the carrier.
The module of the cellular.
Possible values: [Ingress
, Egress
]
The direction of the traffic.
The element.
The site.
Possible values: [TEN_SEC
, ONE_MIN
, FIVE_MIN
, ONE_HOUR
, ONE_DAY
]
The interval time.
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.
series Series[] required
Information on the series schema.
data Data[] required
Data
datapoints Datapoints[] required
Datapoints
The date and time of the series.
The filter property ID.
Links
The sites.
The values of the filter.
Statistics
The interval time.
The name.
Unit
View the active series details.
The name of the cellular metric. Maz size = 128.
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.
Possible values: [ELEMENT
, INTERFACE
, CELLULAR_MODULE
, DIRECTION
, SITE
, APP
, PATH
, PATH_TYPE
, WANINTERFACE
, PRIORITY
, TRAFFIC_TYPE
, COMMON
, CLIENT_MAC_ADDRESS
, USER
, USER_EMAIL
, RESOLUTION_QUALITY
, None
]
The individual view values.
The summary of the view.
- 200
- 400
- 500
Successful Operation
Schema
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
metrics Metrics[] required
Metrics
series Series[] required
Information on the series schema.
data Data[] required
Data
datapoints Datapoints[] required
Datapoints
The date and time of the series.
The filter property ID.
Links
The sites.
The values of the filter.
Statistics
The interval time.
The name.
Unit
View the active series details.
{
"metrics": [
{
"series": [
{
"data": [
{
"datapoints": [
{
"duration": "2023-09-23T07:00:34.979Z",
"filter_property_id": "string",
"links": [
"string"
],
"sites": [
"string"
],
"value": 0
}
],
"statistics": {}
}
],
"interval": "string",
"name": "string",
"unit": "string",
"view": {}
}
]
}
]
}
Bad Request
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_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
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "SERVER_ERROR"
}
]
}
}