---
title: "GET /v1/metrics/search"
method: GET
path: "/v1/metrics/search"
tags: ["metrics"]
---

# GET /v1/metrics/search

`GET /v1/metrics/search`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/metrics/search`
- Auth: none declared

Search metrics by keywords. Returns relevance-ranked search hits. Get further details via get metric by `id`, or list metrics filtered by `identifiers`. A metric or dimension may carry the data team's AI context. `synonyms`: Other names people use for this, e.g. abbreviations or terms in other languages. `examples` (metrics only): Sample questions this metric answers. `agentInstructions`: The data team's guidance for AI agents on using this. Follow it whenever this is part of what you query or present.

## Query parameters

- `q` string, required: Search keywords.
- `limit` integer: Maximum number of hits to return.

## Response `200`

Response for status 200

- object
  - `data` object[], required
    - `id` string, required: Unique resource ID (opaque).
    - `identifier` string, required: Readable semantic model key. Used to cross-reference objects in the semantic model.
    - `label` string, required
    - `link` string, required
    - `descriptionPreview` string, required: Up to 200 characters of the metric description.
    - `timeGrains` string[], required: Grains this metric can be queried at; `null` means all grains. A restricted set (e.g. only `monthly`) means query periods must align to whole allowed periods.
    - `synonyms` string[], required: Other names people use for this, e.g. abbreviations or terms in other languages.
    - `examples` string[], required: Sample questions this metric answers.
    - `agentInstructions` unknown, required

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

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