v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

metricsSearchesManagementV2

Update a metrics search page.

Update a metrics search page by the given identifier.

put/v2/metricsSearches/{id}

Path parameters

idstring required

Unique identifier of the metrics search page to return.

Request body

titlestring required

Title of the metrics search page.

descriptionstring

Description of the metrics search page.

visualSettingsstring

Visual settings of the metrics search page.

folderIdstring

The identifier of the folder to save the metrics search in. By default it is saved in your personal folder.

Example request

{
  "timeRange": {
    "type": "BeginBoundedTimeRange",
    "from": {
      "type": "RelativeTimeRangeBoundary",
      "relativeTime": "-15m"
    }
  },
  "queries": [
    {
      "queryString": "_sourceCategory=cqsplitter metric=CPU_user | count by _sourceHost",
      "queryType": "Logs",
      "queryKey": "A",
      "metricsQueryMode": "Basic",
      "metricsQueryData": {
        "metric": "CPU_user",
        "aggregationType": "count",
        "groupBy": "_sourceHost",
        "filters": [
          {
            "key": "_sourceCategory",
            "value": "kubernetes"
          },
          {
            "key": "_sourceHost",
            "value": "dep-kubernetes-1"
          }
        ],
        "operators": {
          "operatorName": "avg",
          "parameters": [
            {
              "key": "aggregator",
              "value": "max"
            },
            {
              "key": "operation",
              "value": ""
            },
            {
              "key": "value",
              "value": 50
            }
          ]
        }
      },
      "tracesQueryData": {
        "filters": [
          {
            "type": "FieldDescriptor"
          }
        ]
      },
      "spansQueryData": {
        "filters": [
          {
            "type": "StandaloneKey",
            "fieldName": "service"
          }
        ],
        "visualizations": [
          {
            "type": "count",
            "name": "duration_pct_95"
          }
        ],
        "groupBy": [
          {
            "type": "time"
          }
        ],
        "limit": [
          {
            "direction": "asc",
            "limitValue": 10
          }
        ]
      },
      "parseMode": "Auto",
      "timeSource": "Message",
      "outputCardinalityLimit": 1000
    }
  ],
  "folderId": "000000000C1C17C6"
}

Response

The metrics search page was successfully modified.