---
title: "List all Usage Metrics"
method: GET
path: "/usage-metrics"
tags: ["Usage Metrics"]
---

# List all Usage Metrics

`GET /usage-metrics`

List all Usage Metrics

## Query parameters

- `limit` integer
- `after` string
- `before` string
- `name` string
- `id` string
- `eventType` string
- `eventProperty` string
- `aggregationType` string

## Headers

- `Authorization` string, required
- `Sequence-Version` '2024-07-30'

## Response `200`

OK

- ListUsageMetricEndpointProductResponseModel
  - `items` UsageMetric[], required — Usage metrics
    - `id` string, required — Unique ID
    - `sequenceAccountId` string, required — Sequence Account ID
    - `name` string, required — Human-readable name for this metric, which should be unique
    - `description` string, nullable — Description for this metric
    - `metricType` 'SIMPLE' | 'GROUPED', required
    - `eventType` string, required — The `eventType` of the Usage Event to be aggregated
    - `aggregationType` 'COUNT' | 'UNIQUE' | 'SUM' | 'CUSTOM', required
    - `aggregationProperty` string, nullable — Property within the event to aggregate
    - `groupingProperty` string, nullable — Property within the event to group results by
    - `unit` string, nullable — Human-readable unit of the aggregated metric, eg. API calls)
    - `createdAt` string, nullable — Created at
    - `deletedAt` string, nullable — Created at
    - `propertyFilters` object, required
    - `caseSensitive` boolean, nullable
    - `propertiesToNegate` string[], nullable
    - `parameters` CustomMetricParameter[], required — Required parameters
      - `id` string, required
      - `usageMetricId` string, required
      - `name` string, required
      - `type` 'INTEGER' | 'POSITIVE_INTEGER' | 'NUMBER' | 'POSITIVE_NUMBER', required
      - `description` string, required
      - `defaultValue` string, required
  - `pagination` PaginationMeta3, required — Results pagination
    - `after` string, nullable — Cursor for the page after this (if it exists)
    - `before` string, nullable — Cursor for the page before this (if it exists)
    - `totalResultSize` integer, nullable — Total number of entries across all pages

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

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