Get Time Series Stats.

get

https://cluster.ip.address/v2/stats/time-series-stats

Privileges: CLUSTER_VIEW, TENANT_VIEW, STORAGE_DOMAIN_VIEW, STORAGE_VIEW, PROTECTION_VIEW

Get Time Series Stats.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

schemaName

string

required

Specifies the schema name.

metricNames

array of strings

required

length ≥ 1

Specifies a list of metric names.

metricNames*

entityId

string

Specifies the entity id.

entityIdList

array of strings

length ≥ 1

Specifies an entity id list represented as a string. The stats result will be the sum over all these entities. Duplicate id's will be ignored. If both EntityIdList and EntityId are specified, EntityId will be ignored.

entityIdList

prorateDataPoints

boolean

Specifies to create pro rated data point for every rollup interval instead of returning the actual raw data points. This should be used only when rollup function is provided.

includeGrowthChange

boolean

Specifies if the response should return the difference of a data point with the previous datapoint. Used for determining the change in growth rate. Datapoint could be +x, 0, -x showing the growth is up, no change or down respectively.

startTimeMsecs

int64

required

Specifies the start time of series stats.

endTimeMsecs

int64

Specifies the end time of series stats, by default it is current time.

rollupFunction

string

enum

Specifies the rollup function to apply to the data points for the time interval specified by rollupInternalSecs.

rollupIntervalSecs

int32

Specifies the time interval granularity for the specified rollup function.

200Success

defaultError