Class MetricsQueryResponse

Response Object that includes your query and the list of metrics retrieved.

Hierarchy

  • MetricsQueryResponse

Constructors

constructor

Properties

additionalProperties? error? fromDate? groupBy? message? query? resType? respVersion? series? status? times? toDate? values?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional error

error?: string

Message indicating the errors if status is not ok.

Optional fromDate

fromDate?: number

Start of requested time window, milliseconds since Unix epoch.

Optional groupBy

groupBy?: string[]

List of tag keys on which to group.

Optional message

message?: string

Message indicating success if status is ok.

Optional query

query?: string

Query string

Optional resType

resType?: string

Type of response.

Optional respVersion

respVersion?: number

Version of the response format.

Optional series

series?: MetricsQueryMetadata[]

List of timeseries queried.

Optional status

status?: string

Status of the query.

Optional times

times?: any[]

Legacy field, always returned as an empty list. Timestamps are returned in the pointlist of each entry of series.

Optional toDate

toDate?: number

End of requested time window, milliseconds since Unix epoch.

Optional values

values?: any[]

Legacy field, always returned as an empty list. Timeseries values are returned in the pointlist of each entry of series.

Settings

Member Visibility

Theme

Generated using TypeDoc