Retrieve a list of subscriber identifiers with their metrics

get

https://some.bqn.net:3443/api/v1/metrics/subscriberIds

Retrieve a list of subscriber identifiers with their metrics.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

string

required

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2})?([+-]\d{2}(:?\d{2})?|Z)?$

Start date and time of the reported metrics. In format YYYY-MM-DDTHH:MM[:SS][TZ], where the timezone is Z (UTC) or a +-hh, +-hhmm or +-hh:mm UTC offset. If no time zone specified, the one of the BQN server is used.

duration

int64

10 to 133920

Defaults to 60

Time period to return metrics from date. In minutes (default: 60 minutes). If server returns 500 code for lack of resources, try a smaller period

metrics

array of strings

Defaults to accessRtx,inetRtx,accessRttMin,accessRttMed,accessRttP80,inetRttMin,accessCongestion,upVolume,dnVolume

List of metrics to return, separated by commas. All metrics returned by default

metrics

interval

int64

≥ 10

Defaults to 10

Time interval between metrics. In minutes. Default and minimum value: 10 minutes. It is different from per-resource interval (default of 60 and minimum of 1) to keep bulk queries from becoming too expensive to process.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

200Return a list of subscriber identifiers with the metrics from the date and time and duration.

400Bad parameter in request.

401Request received from unauthorized client.

500Internal Server Error.