Lightdash Query 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 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.0.0, at version 0.3156.1.
Requests are made against a single base URL, /.
The identity and technical contract details declared by the specification.
DateZoom
object
2 properties
ApiDownloadAsyncQueryResults
object
1 property
1 required
ApiExecuteAsyncMetricQueryResults
ApiSuccess_ApiDownloadAsyncQueryResults-or-ApiDownloadAsyncQueryResultsAsCsv-or-ApiDownloadAsyncQueryResultsAsXlsx_
object
2 properties
2 required
FieldUrl
object
2 properties
2 required
ApiExecuteAsyncFieldValueSearchResults
object
2 properties
2 required
ApiExecuteAsyncQueryResultsCommon
object
5 properties
5 required
Pick_CompiledDimension.name-or-label-or-table_
object
From T, pick a set of properties whose keys are in the union K
PivotConfiguration
object
9 properties
1 required
Metric
object
33 properties
8 required
CommonExecuteQueryRequestParams
object
4 properties
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
QueryResultsPerformance
object
3 properties
3 required
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
ApiSuccess_ApiExecuteAsyncDashboardSqlChartQueryResults_
object
2 properties
2 required
ExecuteAsyncFieldValueSearchRequestParams
OrFilterGroup
object
2 properties
2 required
FixedWidthBinDimension
object
7 properties
7 required
QueryWarning
object
3 properties
1 required
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
QueryHistoryStatus.QUEUED
string
DimensionOverrides
object
BinType.FIXED_NUMBER
string
ResultColumn
object
2 properties
2 required
Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_
object
Construct a type with a set of properties K of type T
ApiGetAsyncQueryResultsResponse
object
2 properties
2 required
ExecuteAsyncSavedChartRequestParams
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
ResultValue
object
2 properties
2 required
TableCalculationType
string
CustomGroupBinDimension
object
7 properties
7 required
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
ApiJobScheduledResponse
object
2 properties
2 required
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_
Construct a type with the properties of T except for those in type K.
Pick_MetricQueryRequest.Exclude_keyofMetricQueryRequest.csvLimit__
object
From T, pick a set of properties whose keys are in the union K
15 properties
7 required
ExecuteAsyncSqlQueryRequestParams
ExecuteAsyncCalculateTotalRequestParams
object
3 properties
1 required
ApiExecuteAsyncSqlQueryResults
CacheMetadata
object
5 properties
1 required
ExecuteAsyncUnderlyingDataRequestParams
DefaultTimeDimension
object
2 properties
2 required
QueryHistoryStatus.CANCELLED
string
BinRange
object
2 properties
FieldTarget
object
1 property
1 required
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
QueryHistoryStatus.ERROR
string
Omit_MetricQueryRequest.csvLimit_
Construct a type with the properties of T except for those in type K.
ApiDownloadAsyncQueryResultsAsCsv
object
2 properties
2 required
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
QueryHistoryStatus.EXPIRED
string
ExecuteAsyncDashboardSqlChartCommonParams
PreAggregateMissReason.USER_BYPASS
string
Filters
object
3 properties
BinGroup
object
2 properties
2 required
AdditionalMetric
object
23 properties
4 required
ApiSuccess_ApiExecuteAsyncSqlQueryResults_
object
2 properties
2 required
Pick_DownloadAsyncQueryResultsRequestParams.Exclude_keyofDownloadAsyncQueryResultsRequestParams.queryUuid__
object
From T, pick a set of properties whose keys are in the union K
9 properties
ExecuteAsyncDashboardSqlChartRequestParams
Source
object
4 properties
3 required
FrameBoundary
object
2 properties
1 required
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
Record_string.ResultColumn_
object
Construct a type with a set of properties K of type T
QueryResultsMetadata
object
1 property
1 required
MetricQuery
object
14 properties
7 required
ApiSuccess_ApiExecuteAsyncMetricQueryResults_
object
2 properties
2 required
QueryHistoryStatus.EXECUTING
string
SortField
object
4 properties
2 required
VizAggregationOptions
string
GroupValueRule
object
2 properties
2 required
PivotIndexColum
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
DashboardFilters
object
3 properties
3 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…
ApiSuccessEmpty
object
2 properties
1 required
FilterRule
object
8 properties
3 required
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties
3 required
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
ExecuteAsyncDashboardSqlChartByUuidRequestParams
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
Field
object
20 properties
8 required
QueryHistoryStatus.PENDING
string
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FixedNumberBinDimension
object
7 properties
7 required
Record_string._value-ResultValue__
object
Construct a type with a set of properties K of type T
BinType.CUSTOM_RANGE
string
ApiSuccess_ApiExecuteAsyncFieldValueSearchResults_
object
2 properties
2 required
GroupValueMatchType
string
VizSortBy
object
4 properties
2 required
PivotValuesColumn
object
5 properties
4 required
ApiDownloadAsyncQueryResultsAsXlsx
object
2 properties
2 required
TableCalculationTemplateType.RUNNING_TOTAL
string
QueryExecutionContext
string
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.
GroupByColumn
object
1 property
1 required
BinType.CUSTOM_GROUP
string
CustomFormat
object
9 properties
1 required
WindowFunctionType
string
ApiExecuteAsyncDashboardChartQueryResults
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
TableCalculationTemplateType.RANK_IN_COLUMN
string
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
ApiExecuteAsyncDashboardSqlChartQueryResults
BinType.FIXED_WIDTH
string
DashboardFieldTarget
object
4 properties
2 required
ApiSuccess_ApiExecuteAsyncDashboardChartQueryResults_
object
2 properties
2 required
ExecuteAsyncMetricQueryRequestParams
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
SourcePosition
object
2 properties
2 required
ExecuteAsyncSqlChartBySlugRequestParams
QueryHistoryStatus.READY
string
ValuesColumn
object
2 properties
2 required
KnexPaginateArgs
object
2 properties
2 required
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
CustomDimensionType.BIN
string
ExecuteAsyncSqlChartByUuidRequestParams
ExecuteAsyncSqlChartRequestParams
ExecuteAsyncDashboardChartRequestParams
PivotConfig
object
8 properties
2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
ExecuteAsyncDashboardSqlChartBySlugRequestParams
CustomSqlDimension
object
6 properties
6 required
AndFilterGroup
object
2 properties
2 required
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties
3 required
CustomDimensionType.SQL
string
ResultsPaginationMetadata_ResultRow_
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lightdash publishes across the network.
