---
title: "Get Available Metric Templates"
method: GET
path: "/v2/reporting/templates"
tags: ["Reporting"]
---

# Get Available Metric Templates

`GET /v2/reporting/templates`

Retrieves a list of all available metric templates (e.g., GROSS_VOLUME, TRANSACTION_COUNT). Templates define the logic, supported parameters, and breakdown options available for building reports.

## Response `200`

Success

- TemplateListResponse — List of templates response
  - `status` 'success'
  - `data` MetricTemplate[]
    - `name` string — Template identifier
    - `displayName` string — Human-readable template name
    - `description` string — Template description
    - `params` MetricParamDefinition[] — Available parameters for this template
      - `name` string — Parameter name
      - `type` 'date' | 'string' | 'array' | 'enum' | 'integer' — Parameter data type
      - `required` boolean — Whether this parameter is required
      - `description` string — Parameter description
      - `options` unknown[] — Available options (for enum/array types)
        - unknown
      - `constraints` object — Validation constraints (e.g., min, max, maxItems)
    - `supportsBreakdowns` boolean — Whether this template supports breakdown dimensions
    - `breakdownOptions` string[] — Available breakdown dimensions for this template
  - `metadata` object
    - `count` integer

## Other responses

- `400` — Bad request - validation error
- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifibridge/apis/hifi-api.md) · [All operations](https://skmtc.net/hifibridge/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifibridge/hifi-api/versions/74d9e530fbea/schema)