metrics

GET /v1/metrics

List metrics for your workspace. Use for broader catalog exploration. For targeted discovery, prefer metric search over scanning this list. 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.

Request

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

Query parameters

expandstring boolean

Boolean string. When true, populates dimensions, module, slices, cohort, owners, category, filters, and teamIdsWithAccess. When false, those fields are null. Avoid expand=true unless filtering by identifiers, as an expanded full-catalog response can be large.

identifiersstring[]

Filter to metrics with these exact metric.identifiers (Readable semantic model keys).

Response

Response for status 200

totalnumber required
limitnumber required
skipnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.