---
title: "Get explore"
method: GET
path: "/api/v1/projects/{projectUuid}/explores/{exploreId}"
tags: ["Projects"]
---

# Get explore

`GET /api/v1/projects/{projectUuid}/explores/{exploreId}`

Get a specific explore

## Path parameters

- `exploreId` string, required
- `projectUuid` string, required

## Response `200`

Success

- object
  - `results` ApiExploreResults, required — From T, pick a set of properties whose keys are in the union K
    - `name` string, required
    - `parameters` RecordStringLightdashProjectParameter — Construct a type with a set of properties K of type T
    - `label` string, required
    - `caseSensitive` boolean
    - `type` 'virtual' | 'default' | 'pre_aggregate'
    - `spotlight` object
      - `owner` string
      - `categories` string[]
      - `visibility` 'show' | 'hide', required
    - `tags` string[], required
    - `warehouse` string
    - `groupLabel` string
    - `groups` string[] — Nested groups for the sidebar (max 5 levels). Group keys resolve to labels/descriptions via the project-level `table_groups` config (fetched separately); missing keys fall back to using the key as the label.
    - `baseTable` string, required
    - `joinedTables` CompiledExploreJoin[], required
      - `hidden` boolean
      - `table` string, required
      - `type` 'inner' | 'full' | 'left' | 'right'
      - `sqlOn` string, required
      - `always` boolean
      - `relationship` 'one-to-many' | 'many-to-one' | 'one-to-one' | 'many-to-many'
      - `parameterReferences` string[]
      - `tablesReferences` string[]
      - `compiledSqlOn` string, required
    - `tables` object, required
    - `targetDatabase` 'bigquery' | 'databricks' | 'snowflake' | 'redshift' | 'postgres' | 'duckdb' | 'trino' | 'clickhouse' | 'athena' | 'spark', required
    - `databricksCompute` string
    - `ymlPath` string
    - `sqlPath` string
    - `aiHint` union
      - string
      - string[]
    - `granularityLabels` PartialRecordTimeFramesString — Make all properties in T optional
      - `RAW` string
      - `YEAR` string
      - `QUARTER` string
      - `MONTH` string
      - `WEEK` string
      - `DAY` string
      - `HOUR` string
      - `MINUTE` string
      - `SECOND` string
      - `MILLISECOND` string
      - `DAY_OF_WEEK_INDEX` string
      - `DAY_OF_MONTH_NUM` string
      - `DAY_OF_YEAR_NUM` string
      - `WEEK_NUM` string
      - `MONTH_NUM` string
      - `QUARTER_NUM` string
      - `YEAR_NUM` string
      - `DAY_OF_WEEK_NAME` string
      - `MONTH_NAME` string
      - `QUARTER_NAME` string
      - `HOUR_OF_DAY_NUM` string
      - `MINUTE_OF_HOUR_NUM` string
    - `savedParameterValues` ParametersValuesMap — Construct a type with a set of properties K of type T
    - `preAggregates` PreAggregateDef[]
      - `materializationRole` PreAggregateMaterializationRole
        - `attributes` UserAttributeValueMap, required — Construct a type with a set of properties K of type T
        - `email` string, required
      - `refresh` object
        - `cron` string
      - `maxRows` number, double
      - `granularity` 'RAW' | 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' | 'DAY_OF_WEEK_INDEX' | 'DAY_OF_MONTH_NUM' | 'DAY_OF_YEAR_NUM' | 'WEEK_NUM' | 'MONTH_NUM' | 'QUARTER_NUM' | 'YEAR_NUM' | 'DAY_OF_WEEK_NAME' | 'MONTH_NAME' | 'QUARTER_NAME' | 'HOUR_OF_DAY_NUM' | 'MINUTE_OF_HOUR_NUM'
      - `timeDimension` string
      - `filters` MetricFilterRule[]
        - `includeNull` boolean — For the `equals` operator on string fields, also match rows where the field is null (compiles to `field IN (...) OR field IS NULL`). Lets users combine null with selected values in a single "is" rule.
        - `values` AnyType[] — Values to filter by
          - unknown
        - `operator` 'isNull' | 'notNull' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'include' | 'doesNotInclude' | 'lessThan' | 'lessThanOrEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'inThePast' | 'notInThePast' | 'inTheNext' | 'inTheCurrent' | 'notInTheCurrent' | 'inBetween' | 'notInBetween' | 'inPeriodToDate', required
        - `id` string, required — Unique identifier for the filter
        - `target` object, required — Target field for the filter
          - `fieldRef` string, required — Field reference to filter on (e.g., 'table_name.field_name')
        - `settings` unknown
        - `disabled` boolean — Whether this filter is disabled
        - `required` boolean — Whether this filter is required
        - `caseSensitive` boolean — Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field's configured setting.
      - `metrics` string[], required
      - `dimensions` string[], required
      - `name` string, required
    - `preAggregateSource` PreAggregateSource
      - `preAggregateName` string, required
      - `sourceExploreName` string, required
    - `warnings` InlineError[] — Non-fatal compilation or validation warnings (e.g. fields that failed to compile, warehouse-rejected column references). The explore is still usable.
      - `message` string, required
      - `type` 'METADATA_PARSE_ERROR' | 'NO_DIMENSIONS_FOUND' | 'SKIPPED_JOIN' | 'MISSING_TABLE' | 'FIELD_ERROR' | 'SET_VALIDATION_ERROR' | 'INVALID_PARAMETER' | 'DUPLICATE_FIELD_NAME' | 'WAREHOUSE_COLUMN_ERROR', required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.dev/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.dev/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/revisions/40c933755c9a/schema)