v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
metricsSearchesManagementV2

Create a new metrics search page.

Creates a new metrics search page.

post/v2/metricsSearches

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 has been created.

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.

idstring

Unique identifier for the metrics search page.

Example response

{
  "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",
  "id": "B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2"
}