Get

/monitors/{id}/

This endpoint returns the properties of a specified analytics report.

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

Responses

200

Expand All

object

id

integer

name

string

Monitor name

limit

integer

exclude_patterns

Array of string

string

object_type

string

Object type

monitor_type

string

Monitor type (predefined, custom, etc)

from_time

string (date-time)

to_time

string (date-time)

time_frame

string

Time frame to use

object_ids

object

Only query metrics on these objects (optional)

prop_list

object

Only query these metrics (optional)

granularity

string

Data granularity

aggregation

string

Aggregation function. avg, min, max etc.

query_aggregation

string

Special aggregations to apply on query, e.g intersampling

metrics_exposure

string

Monitor's metrics exposure

Return Details of an Analytics Report