Skip to main content
Monitoring & Collection/Monitoring Query & Overview

GetQueryTemplates

List available query templates organized by category

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

Operation ID

GetQueryTemplates

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier of the query template

      Example: tpl-001-abc

    • name
      String

      Display name of the query template

      Example: Average CPU by VM

    • description
      String

      Description of what this template queries

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

    • category
      String

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

      Example: compute

    • query
      Object

      Query for this resource

      • metric
        String

        Metric name to query

        Example: cpu_usage_percent

      • filters
        LinkedHashMap

        Filter criteria to narrow down results

        Example: (nested object)

      • condition
        String

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

        Example: resource_type='vm'

      • timeRange
        String

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

        Example: 1h

      • aggregation
        String

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

        Example: avg

      • groupBy
        List

        Group by

        Example: item1,item2

    • createDate
      String

      Create date

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

    • usageCount
      Integer

      Number of times this template has been used

      Example: 17