Skip to main content
ZStack
Infrastructure/Metrics Catalog

ListCategories

List all metric categories available in the catalog.

GET/api/v1/metrics/categories

Operation ID

ListCategories

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: item1,item2

  • total
    Integer

    Total number of metric categories

    Example: 5

  • limit
    Integer

    Maximum number of categories returned per page

    Example: 20

  • offset
    Integer

    Number of categories skipped from the start

    Example: 20