---
title: "List project metrics"
method: GET
path: "/api/v1/projects/{projectId}/metrics"
tags: ["Projects"]
---

# List project metrics

`GET /api/v1/projects/{projectId}/metrics`

## Request

- Base URL: `https://app.khotan.com`
- URL: `https://app.khotan.com/api/v1/projects/{projectId}/metrics`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

Returns the project's metrics with their attributes, curation, and last-reported time, in curated order. Hidden metrics are included only for owner, admin, and developer keys.

## Path parameters

- `projectId` string, required

## Response `200`

The project's metrics.

- object
  - `metrics` object[], required
    - `key` string, required
    - `name` string, required: The name shown: the curated name, else the reported name, else the key.
    - `displayName` string, nullable, required
    - `reportedName` string, nullable, required
    - `shape` 'series' | 'breakdown' | 'scatter', required
    - `grain` 'day' | 'hour', nullable, required
    - `unit` string, required
    - `goal` 'increase' | 'decrease' | 'neutral', required: Which direction of change is good news.
    - `aggregate` 'sum' | 'average' | 'latest', required: How values across a range combine into one number.
    - `description` string, nullable, required
    - `axes` object, nullable, required
      - `xLabel` string, required
      - `xUnit` string, required
      - `yLabel` string, required
      - `yUnit` string, required
    - `position` integer, required
    - `hidden` boolean, required
    - `headline` boolean, required
    - `headlineSlot` integer, nullable, required
    - `lastReportedAt` string, nullable, required
    - `createdAt` string, required
    - `updatedAt` string, required

## Other responses

- `401`: Authentication is missing or invalid.
- `404`: The resource was not found.
- `429`: Too many requests; retry after the indicated delay.

---

[API](https://skmtc.dev/khotan/apis/khotan-api.md) - [All operations](https://skmtc.dev/khotan/apis/khotan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/khotan/apis/khotan-api/revisions/90b512a53e42?raw)