Post

/monitors/

This endpoint defines a custom 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 .

Body parameters

object

name

string

A name for the monitor.

object_type

string Required

The type of object to monitor.

Valid values[ "cluster", "cnode", "dnode", "nvram", "replicationstream", "ssd" ]

from_time

string

Start time of period to report. e.g. 2021-01-15T13:41:52Z

to_time

string

End time of period to report. e.g. 2021-01-15T13:41:52Z

time_frame

string

Default time frame to report over. Examples: 2h (2 hours), 1D (1 Day), 10m (10 minutes), 1M (1 month)

object_ids

string

Specific objects to include in the report, specified as a comma separated list of object IDs.

prop_list

string

A list of metrics to query. To get the full list of metrics, use GET /metrics/.

granularity

string

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

aggregation

string

If data 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" ]

Responses

201

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

Create Custom Analytics Report (aka Monitor)