Retrieve a list of subscriber IPs with their metrics

get

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

Retrieve a list of subscriber IPs 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})?)?$

Start date and time of the reported metrics. In format YYYY-MM-DDTHH:MM[:SS][+-TZ], where timezone is in hh[mm] format. 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,inetRttMin,upVolume,dnVolume

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

metrics

Allowed:

interval

int64

≥ 10

Defaults to 10

Time interval between metrics. In minutes (default: 10 minutes).

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

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

400Bad parameter in request.

401Request received from unauthorized client.

500Internal Server Error.