Query Cellular Metrics (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/cellular_metrics

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

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query request for getting cellularmetrics

end_time date

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

Filters according to the specifications.

apn string[]

The APN name that provides access to the mobile broadband network.

carrier string[]

The name of the carrier.

cellular_module string[]

The module of the cellular.

direction string

Possible values: [Ingress, Egress]

The direction of the traffic.

element string[]

The element.

site string[]

The site.

interval stringrequired

Possible values: [10sec, 1min, 5min, 1hour, 1day]

The interval time.

max_datapoints int32

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[]
Information on the series schema.
Array [
data Data[]
Data
Array [
datapoints Datapoints[]
Datapoints
Array [
duration date-time
The date and time of the series.
filter_property_id string
The filter property ID.
links string[]
Links
ninetieth_percentile number
Ninetieth Percentile
sites string[]
The sites.
value number
The values of the filter.
]
statistics object
Statistics
]
interval string
The interval time.
name string
The name.
unit string
Unit
view object
View the active series details.
]
]
name string

The name of the cellular metric. Maz size = 128.

start_time date

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

The individual and summary views.

individual string

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.

summary boolean

The summary of the view.

Responses

200

Successful Operation

application/json

Schema

Schema

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

Example (from schema)

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2024-04-15T15:13:46.296Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "ninetieth_percentile": 0,
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

500

Internal Server Error

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

Loading...