GetExplore - Lightdash

GET

/

api

/

v1

/

projects

/

{projectUuid}

/

explores

/

{exploreId}

{
  "results": {
    "type": "virtual",
    "sqlPath": "<string>",
    "ymlPath": "<string>",
    "warehouse": "<string>",
    "targetDatabase": "bigquery",
    "tables": {},
    "joinedTables": [
      {
        "table": "<string>",
        "sqlOn": "<string>",
        "type": "inner",
        "hidden": true,
        "always": true,
        "compiledSqlOn": "<string>"
      }
    ],
    "baseTable": "<string>",
    "groupLabel": "<string>",
    "tags": [
      "<string>"
    ],
    "label": "<string>",
    "name": "<string>"
  },
  "status": "ok"
}

Path Parameters

exploreId

string

required

projectUuid

string

required

Response

200

application/json

Success

results

object

required

results.targetDatabase

enum<string>

required

Available options:

bigquery,

databricks,

snowflake,

redshift,

postgres,

trino

results.tables

object

required

results.tables.{key}

object

results.tables.{key}.sqlTable

string

required

results.tables.{key}.schema

string

required

results.tables.{key}.database

string

required

results.tables.{key}.label

string

required

results.tables.{key}.name

string

required

results.tables.{key}.lineageGraph

object

required

Construct a type with a set of properties K of type T

results.tables.{key}.metrics

object

required

Construct a type with a set of properties K of type T

results.tables.{key}.dimensions

object

required

Construct a type with a set of properties K of type T

results.tables.{key}.defaultTimeDimension

object

results.tables.{key}.groupDetails

object

Construct a type with a set of properties K of type T

results.tables.{key}.requiredAttributes

object

Construct a type with a set of properties K of type T

results.tables.{key}.hidden

boolean

results.tables.{key}.requiredFilters

object[]

results.tables.{key}.sqlWhere

string

results.tables.{key}.groupLabel

string

results.tables.{key}.orderFieldsBy

enum<string>

Available options:

LABEL,

INDEX

results.tables.{key}.description

string

results.tables.{key}.originalName

string

results.tables.{key}.uncompiledSqlWhere

string

results.tables.{key}.source

object

results.joinedTables

object[]

required

From T, pick a set of properties whose keys are in the union K

results.baseTable

string

required

results.tags

string[]

required

results.label

string

required

results.name

string

required

results.type

enum<string>

Available options:

virtual,

default

results.sqlPath

string

results.ymlPath

string

results.warehouse

string

results.groupLabel

string

status

enum<string>

required

Available options:

ok

SetExplores CompileQuery

{
  "results": {
    "type": "virtual",
    "sqlPath": "<string>",
    "ymlPath": "<string>",
    "warehouse": "<string>",
    "targetDatabase": "bigquery",
    "tables": {},
    "joinedTables": [
      {
        "table": "<string>",
        "sqlOn": "<string>",
        "type": "inner",
        "hidden": true,
        "always": true,
        "compiledSqlOn": "<string>"
      }
    ],
    "baseTable": "<string>",
    "groupLabel": "<string>",
    "tags": [
      "<string>"
    ],
    "label": "<string>",
    "name": "<string>"
  },
  "status": "ok"
}