Lightdash Query API is one of 49 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 Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes
13 operations
across 13 paths,
and defines 176 schemas.
It is described by OpenAPI 3.2.0, at version 0.3156.1.
Requests are made against a single base URL, /.
The identity and technical contract details declared by the specification.
FieldUrl
object
2 properties
2 required
ExecuteAsyncDashboardChartRequestParams
GroupByColumn
object
1 property
1 required
ApiSuccess_ApiExecuteAsyncDashboardSqlChartQueryResults_
object
2 properties
2 required
AndFilterGroup
object
2 properties
2 required
ApiDownloadAsyncQueryResults
object
1 property
1 required
CustomRangeBinDimension
object
7 properties
7 required
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
KnexPaginateArgs
object
2 properties
2 required
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
ExecuteAsyncDashboardSqlChartBySlugRequestParams
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
CommonExecuteQueryRequestParams
object
4 properties
ExecuteAsyncSqlChartBySlugRequestParams
BinType.FIXED_NUMBER
string
ApiSuccessEmpty
object
2 properties
1 required
ApiSuccess_ApiDownloadAsyncQueryResults-or-ApiDownloadAsyncQueryResultsAsCsv-or-ApiDownloadAsyncQueryResultsAsXlsx_
object
2 properties
2 required
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties
3 required
CustomFormat
object
9 properties
1 required
ApiExecuteAsyncFieldValueSearchResults
object
2 properties
2 required
ApiSuccess_ApiExecuteAsyncMetricQueryResults_
object
2 properties
2 required
BinRange
object
2 properties
DimensionOverrides
object
TableCalculationTemplateType.RANK_IN_COLUMN
string
Pick_DownloadAsyncQueryResultsRequestParams.Exclude_keyofDownloadAsyncQueryResultsRequestParams.queryUuid__
object
From T, pick a set of properties whose keys are in the union K
9 properties
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
ValuesColumn
object
2 properties
2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
ResultColumn
object
2 properties
2 required
GroupValueRule
object
2 properties
2 required
ApiExecuteAsyncQueryResultsCommon
object
5 properties
5 required
TableCalculationTemplateType.RUNNING_TOTAL
string
QueryWarning
object
3 properties
1 required
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
TableCalculationBase
object
5 properties
2 required
SortField
object
4 properties
2 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…
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties
2 required
CustomDimensionType.SQL
string
VizAggregationOptions
string
Source
object
4 properties
3 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
ExecuteAsyncMetricQueryRequestParams
ExecuteAsyncCalculateTotalRequestParams
object
3 properties
1 required
ApiDownloadAsyncQueryResultsAsXlsx
object
2 properties
2 required
ResultsPaginationMetadata_ResultRow_
Metric
object
33 properties
8 required
FixedWidthBinDimension
object
7 properties
7 required
VizSortBy
object
4 properties
2 required
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties
3 required
QueryHistoryStatus.EXPIRED
string
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
ExecuteAsyncDashboardSqlChartByUuidRequestParams
CustomSqlDimension
object
6 properties
6 required
PivotConfiguration
object
9 properties
1 required
ExecuteAsyncSqlQueryRequestParams
PivotValuesColumn
object
5 properties
4 required
PivotIndexColum
object
2 properties
2 required
Pick_Metric.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
FieldTarget
object
1 property
1 required
Omit_MetricQueryRequest.csvLimit_
Construct a type with the properties of T except for those in type K.
ResultValue
object
2 properties
2 required
GroupValueMatchType
string
Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_
Construct a type with the properties of T except for those in type K.
DateZoom
object
2 properties
ExecuteAsyncSavedChartRequestParams
CustomDimensionType.BIN
string
ExecuteAsyncSqlChartByUuidRequestParams
ExecuteAsyncSqlChartRequestParams
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
ApiExecuteAsyncSqlQueryResults
CalculateTotalKind
string
Kinds of totals derivable from an executed pivot query. Follow-up PRs will widen the union to enable the commented-out variants below.
ApiJobScheduledResponse
object
2 properties
2 required
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
Pick_CompiledDimension.name-or-label-or-table_
object
From T, pick a set of properties whose keys are in the union K
ApiExecuteAsyncMetricQueryResults
BinType.FIXED_WIDTH
string
QueryHistoryStatus.EXECUTING
string
QueryExecutionContext
string
Field
object
20 properties
8 required
ApiDownloadAsyncQueryResultsAsCsv
object
2 properties
2 required
ExecuteAsyncUnderlyingDataRequestParams
CustomGroupBinDimension
object
7 properties
7 required
FrameBoundary
object
2 properties
1 required
QueryHistoryStatus.ERROR
string
ApiSuccess_ApiExecuteAsyncDashboardChartQueryResults_
object
2 properties
2 required
ApiSuccess_ApiExecuteAsyncSqlQueryResults_
object
2 properties
2 required
Record_string.ResultColumn_
object
Construct a type with a set of properties K of type T
DashboardFilters
object
3 properties
3 required
Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_
object
Construct a type with a set of properties K of type T
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
BinGroup
object
2 properties
2 required
DashboardFieldTarget
object
4 properties
2 required
QueryResultsMetadata
object
1 property
1 required
AdditionalMetric
object
23 properties
4 required
ApiGetAsyncQueryResultsResponse
object
2 properties
2 required
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
QueryHistoryStatus.CANCELLED
string
MetricQuery
object
14 properties
7 required
DefaultTimeDimension
object
2 properties
2 required
CacheMetadata
object
5 properties
1 required
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
QueryResultsPerformance
object
3 properties
3 required
SourcePosition
object
2 properties
2 required
QueryHistoryStatus.READY
string
Record_string._value-ResultValue__
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
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
ExecuteAsyncDashboardSqlChartCommonParams
BinType.CUSTOM_GROUP
string
PivotConfig
object
8 properties
2 required
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
FixedNumberBinDimension
object
7 properties
7 required
TableCalculationType
string
ExecuteAsyncDashboardSqlChartRequestParams
TableCalculationTemplateType.WINDOW_FUNCTION
string
Pick_MetricQueryRequest.Exclude_keyofMetricQueryRequest.csvLimit__
object
From T, pick a set of properties whose keys are in the union K
15 properties
7 required
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FrameClause
object
3 properties
2 required
Filters
object
3 properties
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
QueryHistoryStatus.PENDING
string
QueryHistoryStatus.QUEUED
string
ApiSuccess_ApiExecuteAsyncFieldValueSearchResults_
object
2 properties
2 required
ApiExecuteAsyncDashboardSqlChartQueryResults
ApiExecuteAsyncDashboardChartQueryResults
PreAggregateMissReason.USER_BYPASS
string
BinType.CUSTOM_RANGE
string
WindowFunctionType
string
OrFilterGroup
object
2 properties
2 required
FilterRule
object
8 properties
3 required
ExecuteAsyncFieldValueSearchRequestParams
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lightdash publishes across the network.
