How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightdash Exploring API

The Exploring API from Lightdash — 3 operation(s) for exploring.

Lightdash Exploring API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Exploring. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 93 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

3 operations 3 paths 93 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Exploring API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Exploring 3
POST
/api/v1/projects/{projectUuid}/explores/{exploreId}/runUnderlyingDataQuerydeprecated
Run underlying data query
postRunUnderlyingDataQuery 2 params body → 200default
POST
/api/v1/projects/{projectUuid}/explores/{exploreId}/runQuerydeprecated
Run metric query
RunMetricQuery 2 params body → 200default
POST
/api/v1/projects/{projectUuid}/sqlQuerydeprecated
Run SQL query
RunSqlQuery 1 param body → 200default

Schemas 93

The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are Metric (33 properties), AdditionalMetric (23 properties), Field (20 properties), MetricQueryRequest (16 properties). Each schema is shown below with its type and property counts.

DateZoom
object
2 properties
FieldUrl
object
2 properties 2 required
DateGranularity
string
Metric
object
33 properties 8 required
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
ApiRunQueryResponse
object
2 properties 2 required
FieldType.METRIC
string
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
Pick_Metric.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
FixedWidthBinDimension
object
7 properties 7 required
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
DimensionOverrides
object
BinType.FIXED_NUMBER
string
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
TableCalculationType
string
CustomGroupBinDimension
object
7 properties 7 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
FrameBoundaryType
string
FormulaTableCalculation
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
FrameType
string
FieldId
string
CacheMetadata
object
5 properties 1 required
DefaultTimeDimension
object
2 properties 2 required
BinRange
object
2 properties
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
MetricOverrides
object
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.USER_BYPASS
string
PreAggregateMatchMiss
CompactOrAlias
BinGroup
object
2 properties 2 required
Record_string._type-DimensionType__
object
Construct a type with a set of properties K of type T
AdditionalMetric
object
23 properties 4 required
Source
object
4 properties 3 required
FrameBoundary
object
2 properties 1 required
DimensionType
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
SortField
object
4 properties 2 required
MetricType
string
NumberSeparator
string
CustomBinDimension
FiltersResponse
object
3 properties
ApiSqlQueryResults
object
2 properties 2 required
FilterGroupResponse
GroupValueRule
object
2 properties 2 required
FrameClause
object
3 properties 2 required
Pick_CompiledDimension.label-or-name-or-table_
object
From T, pick a set of properties whose keys are in the union K
3 properties 3 required
TableCalculationTemplateType.WINDOW_FUNCTION
string
MetricQueryRequest
object
16 properties 7 required
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
TableCalculation
FieldType
string
TimeFrames
string
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
SqlTableCalculation
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
Field
object
20 properties 8 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FixedNumberBinDimension
object
7 properties 7 required
BinType.CUSTOM_RANGE
string
GroupValueMatchType
string
Compact
string
TableCalculationTemplateType.RUNNING_TOTAL
string
BinType.CUSTOM_GROUP
string
CustomFormat
object
9 properties 1 required
WindowFunctionType
string
CustomRangeBinDimension
object
7 properties 7 required
PivotSortAnchor
object
Coordinates of a single pivot column, used to anchor a row sort to that specific column when results are pivoted.
2 properties 2 required
TableCalculationBase
object
5 properties 2 required
TableCalculationTemplate
TableCalculationTemplateType.RANK_IN_COLUMN
string
TemplateTableCalculation
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
BinType.FIXED_WIDTH
string
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
SourcePosition
object
2 properties 2 required
FilterOperator
string
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
CustomDimensionType.BIN
string
CustomFormatType
string
Record_string.Item-or-AdditionalMetric_
object
Construct a type with a set of properties K of type T
MetricQueryResponse
object
10 properties 7 required
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
CustomSqlDimension
object
6 properties 6 required
Format
string
CustomDimension
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
CustomDimensionType.SQL
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-exploring-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exports API
Lightdash Feature Flag API
Where this information came from

This is an independent, third-party profile of Lightdash Exploring API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.