---
title: "GET /api/exploration/dimensions"
method: GET
path: "/api/exploration/dimensions"
tags: ["/api/exploration"]
---

# GET /api/exploration/dimensions

`GET /api/exploration/dimensions`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/exploration/dimensions`
- Auth: API key in header `X-API-Key`

Hydrated metrics plus a deduplicated dimension list, for the Exploration data modal.

  Optional `q` filters case-insensitively across metric name and dimension display-name.

## Response `2XX`

Successful response

- MetabaseExplorationsApiDimensionsResponse: Schema for GET /dimensions: metrics referencing dimensions by id, plus the grouped dimension list.
  - `dimension_groups` MetabaseExplorationsApiExplorationDimensionGroup[], required
    - `dimension_interestingness` number, nullable, required
    - `dimensions` MetabaseMetricsCoreDimension[], required
      - `default` boolean, nullable
      - `default-temporal-unit` string, nullable
      - `description` string, nullable
      - `dimension-interestingness` number, nullable
      - `display-name` string: Schema for a string that cannot be blank.
      - `effective-type` string, nullable
      - `group` MetabaseMetricsDimensionGroup: The internal dimension-group shape annotated with wire-conversion rules.
        - `display-name` string, required
        - `id` string, required
        - `type` 'main' | 'connection', required
      - `has-field-values` string, nullable
      - `id` string, required
      - `lib/source` union
        - 'source/card' | 'source/native' | 'source/previous-stage' | 'source/table-defaults' | 'source/aggregations' | 'source/joins' | 'source/expressions' | 'source/implicitly-joinable' | 'source/pivot-grouping': `:lib/source` -- where a column came from with respect to the current stage. Traditionally, `:lib/source` meant something slightly different -- it denoted what part of the current stage a column came from, and thus included two additional options -- `:source/fields`, for columns used by `:fields`, and `:source/breakouts`, for columns used in `:breakout`. This was not really useful information and made `:lib/source` itself useless for determining if a column was 'inherited' or not (i.e., whether it came from a previous stage, source card, or a join, and should get field name refs instead of field ID refs -- see [[metabase.lib.field.util/inherited-column?]]).
        - string
      - `name` string, nullable
      - `semantic-type` string, nullable
      - `sources` MetabaseMetricsDimensionSource[], nullable
        - `field-id` integer, nullable
        - `type` 'field', required
      - `status` 'status/active' | 'status/orphaned': Status of a dimension indicating whether it's active or has issues. - :status/active - Column exists, dimension is usable - :status/orphaned - Column was removed from schema, dimension preserved for reference
      - `status-message` string, nullable
    - `name` string, required
  - `metrics` MetabaseExplorationsApiExplorationMetric[], required
    - `collection` object, nullable
      - `id` integer, nullable, required: value must be an integer greater than zero.
      - `name` string, required
    - `collection_id` integer, nullable, required: value must be an integer greater than zero.
    - `database_id` integer, nullable: value must be an integer greater than zero.
    - `description` string, nullable, required
    - `dimension_ids` unknown[], required
      - unknown
    - `dimension_mappings` MetabaseMetricsCoreDimensionMapping[], nullable
      - `dimension-id` string, required
      - `table-id` integer: Valid Table ID
      - `target` union, required
        - unknown[]
          - unknown
        - unknown[]
          - unknown
      - `type` 'table': Type of dimension mapping.
    - `id` integer, required: value must be an integer greater than zero.
    - `in_library` boolean
    - `name` string, required
    - `result_column_name` string, nullable

## Other responses

- `4XX`: Client error response
- `5XX`: Server error response

## Changes

- **2026-11-04** `2e178f5a7934`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metabase/apis/metabase-api/changes/api/exploration/dimensions/get.md)

---

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