v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

metricsSearchesManagementV2

List all metrics search pages.

List all metrics search pages under the Personal folder created by the user or under folders viewable by user.

get/v2/metricsSearches

Query parameters

limitinteger

Limit the number of metric searches returned in the response. The number of metric searches returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

modestring

Example:createdByUser

whether to list all viewable metric searches under the folders

Response

Paginated list of metrics search pages under the Personal folder created by the user or viewable by user.

nextstring

Next continuation token. token is set to null when no more pages are left.

Example response

{
  "metricsSearches": [
    {
      "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"
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}