Get

/monitors/{id}/query/

This endpoint queries for analytics, based on a defined monitor.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Monitor ID, to specify the analytics you want to query.

Query parameters

from_time

string

Start time for the report. e.g. 2021-01-15T13:41:52Z

to_time

string

End time for the report. e.g. 2021-01-15T13:41:52Z

time_frame

string

Time frame to report. Specify as an integer followed by 'm' (minutes) 'h' (hours), 'D' (days) ,'W' (weeks) or 'M' (months) 'Y' (years). e.g. 10m

granularity

string

Data granularity: seconds (raw), minutes (five minute aggregated samples), hours (hourly aggregated samples), or days (daily aggregated samples)

aggregation

string

If granularity is minutes, hours or days, the data is aggregated. This parameter selects which aggregation function to use.

Valid values[ "avg", "min", "max", "latency_weighted_average", "stddev", "sum" ]

format_data

boolean

Defaultfalse

Responses

200

Expand All

object

object_ids

object

list of object ids that appears in the query results

prop_list

object

list of metrics that appears in the result

data

object

list of data samples, each sample in form of [timestamp, obj_id, *data]

Query Analytics using Defined Analytics Report (aka Monitor)