PUT /v1/metricsSearches/{id}

Updates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields.

Servers

Path parameters

Name Type Required Description
id String Yes

Identifier of the metrics search.

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
metricsQueries[] Array Yes

Metrics queries, up to the maximum of six.

metricsQueries[].rowId String Yes

Row identifier. All row IDs are represented by subsequent upper case letters starting with A.

metricsQueries[].query String Yes

Metrics query.

desiredQuantizationInSecs Integer No

Desired quantization in seconds.

Default value: 0

description String Yes

Item description in the content library.

properties String No

Chart properties, like line width, color palette, and the fill missing data method. Leave this field empty to use the defaults. This property contains JSON object encoded as a string.

logQuery String No

Log query used to add an overlay to the chart.

title String Yes

Item title in the content library.

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.