POST /v1/metricsQueries

Execute multiple metrics queries. Limits of this API are described in Metrics Query Error Messages. For general information about Metrics Queries see Metrics Queries.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
queries[] Array Yes

A list of metrics queries.

queries[].rowId String Yes

Row id for the query row, A to Z letter.

queries[].query String Yes

A metric query consists of a metric, one or more filters and optionally, one or more Metrics Operators. Strictly speaking, both filters and operators are optional.

Most of the Metrics Operators are allowed in the query string except fillmissing, outlier, quantize and timeshift.

  • fillmissing: Not supported in API.
  • outlier: Not supported in API.
  • quantize: Only supported through quantization param.
  • timeshift: Only supported through timeshift param.

In practice, your metric queries will almost always contain filters that narrow the scope of your query. For more information about the query language see Metrics Queries.

queries[].quantization Integer No

Segregates time series data by time period. This allows you to create aggregated results in buckets of fixed intervals (for example, 5-minute intervals). The value is in milliseconds.

queries[].timeshift Integer No

Shifts the time series from your metrics query by the specified amount of time. This can help when comparing a time series across multiple time periods. Specified as a signed duration in milliseconds.

queries[].rollup String No

We use the term rollup to refer to the aggregation function Sumo Logic uses when quantizing metrics. Can be Avg, Sum, Min, Max, Count or None.

timeRange Object Yes
timeRange.type String Yes

Type of the time range. Value must be either CompleteLiteralTimeRange or BeginBoundedTimeRange.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.