---
title: "Metric Description"
method: GET
path: "/beta/analytics/metrics/{metricId}"
tags: ["Analytics"]
---

# Metric Description

`GET /beta/analytics/metrics/{metricId}`

This endpoint lists all available properties of a metric to use for querying its data

## Path parameters

- `metricId` string, required

## Response `200`

The metric properties

- GetMetricOutput
  - `data` MetricMetadata, required
    - `id` string, required — The metric ID
    - `description` string — Relevant information about the metric
    - `filters` FilterMetadata[] — List of available filters that can be used when fetching metric data
      - `filterAttribute` string, required
      - `description` string
    - `aggregations` AggregateMetadata[] — List of available aggregations that can be used when fetching metric data
      - `measure` string, required — values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]
      - `description` string
    - `relatedRecordIds` string[] — List of record IDs used to compose the metric

## Other responses

- `400` — Invalid value extracted from request context
- `500` — Internal Server Error

---

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