Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
GETMonitoringSince 1.0SynchronousAuth Required

GetQueryTemplates

List available query templates organized by category

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the query template

      Example: tpl-001-abc

    • nameString

      Display name of the query template

      Example: Average CPU by VM

    • descriptionString

      Description of what this template queries

      Example: Computes average CPU utilization per VM over the selected time range

    • categoryString

      Category grouping (e.g. compute, storage, network)

      Example: compute

    • queryObject

      Query for this resource

      • metricString

        Metric name to query

        Example: cpu_usage_percent

      • filtersLinkedHashMap

        Filter criteria to narrow down results

        Example: (nested object)

      • conditionString

        Filter condition expression (e.g. resource_type='vm')

        Example: resource_type='vm'

      • timeRangeString

        Query time range (e.g. 1h, 24h)

        Example: 1h

      • aggregationString

        Aggregation function (e.g. avg, max, p99)

        Example: avg

      • groupByList

        Group by

        Example: item1,item2

    • createDateString

      Create date

      Example: 2026-01-15T08:00:00Z

    • usageCountInteger

      Number of times this template has been used

      Example: 17

Endpoint

GET/api/v1/monitoring/query-builder/templates

/api/v1/monitoring/query-builder/templates

Operation ID

GetQueryTemplates

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/query-builder/templates' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history