Lightdash SQL runner API
The SQL runner API from Lightdash — 18 operation(s) for sql runner.
Lightdash SQL runner 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 SQL runner. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes 22 operations across 18 paths, and defines 308 schemas. It is described by OpenAPI 3.2.0, at version 0.3156.1.
Requests are made against a single base URL, /.
22 operations
18 paths
308 schemas
2 DELETE9 GET1 PATCH9 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Lightdash SQL runner 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 22
Across 18 paths, the API surfaces 22 operations — 2 DELETE, 9 GET, 1 PATCH, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
SQL runner 22
GET
/api/v1/projects/{projectUuid}/sqlRunner/tables
List warehouse tables
GET
/api/v1/projects/{projectUuid}/sqlRunner/fields
Get table fields
POST
/api/v1/projects/{projectUuid}/sqlRunner/rundeprecated
Run SQL query
POST
/api/v1/projects/{projectUuid}/sqlRunner/runPivotQuerydeprecated
Run SQL pivot query
GET
/api/v1/projects/{projectUuid}/sqlRunner/results/{fileId}deprecated
Get stored results
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Get SQL chart
PATCH
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Update SQL chart
DELETE
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Delete SQL chart
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}
Get SQL chart by slug
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}/results-jobdeprecated
Get SQL chart results job
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/results-jobdeprecated
Get SQL chart results job by UUID
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved
Create SQL chart
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promote
Promote SQL chart
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promoteDiff
Get SQL chart promotion diff
POST
/api/v1/projects/{projectUuid}/sqlRunner/refresh-catalog
Refresh catalog cache
POST
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view
Create virtual view
PUT
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name}
Update virtual view
DELETE
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name}
Delete virtual view
POST
/api/v1/projects/{projectUuid}/sqlRunner/preview
Preview write back
POST
/api/v1/projects/{projectUuid}/sqlRunner/pull-request
Create write back PR
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers
List SQL chart schedulers
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers
Create SQL chart scheduler
Schemas 308
The contract defines 308 schemas that model the data the API accepts and returns. The most detailed are MapChart (26 properties), Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__ (26 properties), SchedulerBase (26 properties), Pick_Dashboard.Exclude_keyofDashboard.inheritsFromOrgOrProject-or-access__ (25 properties). Each schema is shown below with its type and property counts.
ChartKind
string
Pick_Dashboard.uuid-or-name_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
DashboardSqlChartTile
TemplateTableCalculation
ChartType.PIE
string
GroupByColumn
object
1 property
1 required
CustomRangeBinDimension
object
7 properties
7 required
AxisSide
number
UpdatedByUser
object
3 properties
3 required
BinType.FIXED_NUMBER
string
AllVizChartConfig
FunnelChartLabelPosition
string
ApiUpdateSqlChart
object
2 properties
2 required
TableChartConfig
object
2 properties
1 required
MetricType
string
TableCalculationTemplateType.RUNNING_TOTAL
string
OrganizationMemberRole
string
TableCalculationBase
object
5 properties
2 required
ParametersValuesMap
SqlChart
object
20 properties
20 required
MetricOverrides
object
ChartKind.LINE
string
DashboardScheduler
Partial_CompleteEChartsConfig_
object
Make all properties in T optional
10 properties
VizSortBy
object
4 properties
2 required
SankeyNodeLayout
string
How nodes are laid out: - multi-step: depth-unrolled journeys (default) - merged: one node per label, journeys preserved (acyclic flows only) - direct: two-col…
ChartConfig
SqlTableCalculation
Record_string.unknown_
object
Construct a type with a set of properties K of type T
DashboardDAO
Record_string.SeriesMetadata_
object
Construct a type with a set of properties K of type T
CustomSqlDimension
object
6 properties
6 required
VizColumn
object
2 properties
1 required
MapChartConfig
object
2 properties
1 required
DashboardTileTypes.HEADING
string
Pick_SchedulerMsTeamsTarget.webhook_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
NumberSeparator
string
Pick_Explore.name_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
DashboardConfig
object
6 properties
1 required
SqlRunnerPivotQueryBody
PromotionChanges
object
5 properties
3 required
SchedulerJobStatus
string
EChartsConfig
DashboardHeadingTileProperties
object
2 properties
2 required
Pick_SchedulerSlackTarget.channel_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
ApiJobScheduledResponse
object
2 properties
2 required
TableChart
object
12 properties
SpaceAccess
object
6 properties
3 required
LogCounts
object
5 properties
5 required
CustomVis
object
1 property
BinType.FIXED_WIDTH
string
DashboardDataAppTileProperties
object
2 properties
2 required
FunnelChart
object
8 properties
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
CustomGroupBinDimension
object
7 properties
7 required
FrameBoundary
object
2 properties
1 required
SchedulerMsTeamsTarget
object
5 properties
5 required
CustomFormatType
string
PromotedSqlChart
object
8 properties
8 required
SchedulerPdfOptions
VizLineChartConfig
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
DashboardParameterValue
object
2 properties
2 required
Record_string.ColumnProperties_
object
Construct a type with a set of properties K of type T
Omit_Dashboard.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
WarehouseTableSchema
object
ApiCreateSqlChart
object
2 properties
2 required
Pick_Space.organizationUuid-or-projectUuid-or-uuid-or-name-or-inheritParentPermissions-or-projectMemberAccessRole-or-pinnedListUuid-or-pinnedListOrder-or-slug-or-parentSpaceUuid-or-path_
object
From T, pick a set of properties whose keys are in the union K
11 properties
11 required
MapHexbinSizingMode
string
MarkLine
object
4 properties
1 required
ComparisonFormatTypes
string
BinType.CUSTOM_GROUP
string
SortByDirection
string
DashboardTile
SchedulerEmailTarget
object
5 properties
5 required
MapFieldConfig
object
2 properties
FixedNumberBinDimension
object
7 properties
7 required
FrameClause
object
3 properties
2 required
Pick_CreateSchedulerAndTargets.Exclude_keyofCreateSchedulerAndTargets.savedChartUuid-or-dashboardUuid-or-savedSqlUuid-or-createdBy__
object
From T, pick a set of properties whose keys are in the union K
16 properties
9 required
CompactOrAlias
PivotValue
object
2 properties
2 required
DashboardHeadingTile
FilterRule
object
8 properties
3 required
VizColumnConfig
object
8 properties
4 required
ChartType.CUSTOM
string
Pick_SpaceSummary.uuid-or-name-or-userAccess_
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
ChartType.FUNNEL
string
CreateSchedulerAndTargetsWithoutIds
ChartType.BIG_NUMBER
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
DashboardMarkdownTileProperties
object
2 properties
2 required
Pick_Organization.organizationUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
TreemapChartConfig
object
2 properties
1 required
ApiSqlRunnerPivotQueryPayload
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties
3 required
VizCartesianChartConfig
CustomFormat
object
9 properties
1 required
FilterOperator
string
UpdateUnversionedSqlChart
object
3 properties
3 required
ColorPaletteSource
Where a resolved colour palette came from. The config and default cases carry no entity reference; the rest expose the UUID and human-readable name of the enti…
Omit_SavedChart.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
ValuesColumn
object
2 properties
2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
DashboardFilterRule
SankeyChartConfig
object
2 properties
1 required
DashboardChartTileProperties
object
2 properties
2 required
ThresholdOperator
string
ConditionalFormattingMinMax_number-or-auto_
object
2 properties
2 required
MarkLineData
object
9 properties
1 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…
CartesianChartDisplay
object
5 properties
VizAggregationOptions
string
TableCalculationTemplate
ChartScheduler
ConditionalFormattingColorRange
object
2 properties
2 required
RowLimit
object
3 properties
3 required
Record_string.DashboardParameterValue_
object
Construct a type with a set of properties K of type T
VizPieChartConfig
ApiSqlChart
object
2 properties
2 required
PivotConfiguration
object
9 properties
1 required
CartesianSeriesType.LINE
string
WarehouseTablesCatalog
object
PullRequestCreated
object
2 properties
2 required
SchedulerSlackTarget
object
5 properties
5 required
PromotedDashboard
ThresholdOptions
object
3 properties
3 required
ChartType.SANKEY
string
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
FrameBoundaryType
string
AppScheduler
SchedulerRunStatus
string
ChartType.MAP
string
PromotedChart
SpaceMemberRole
string
TableCalculation
Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__
object
From T, pick a set of properties whose keys are in the union K
26 properties
20 required
DashboardFieldTarget
object
4 properties
2 required
SqlChartScheduler
ProjectMemberRole
string
MapHexbinAggregation
string
XAxis
StackType
string
DashboardLoomTile
VizIndexType
string
UpdateVersionedSqlChart
object
3 properties
3 required
XAxisSortType
string
MapChartLocation
string
ApiPromotionChangesResponse
object
2 properties
2 required
DashboardTileTypes.DATA_APP
string
Record_string.never_
object
Construct a type with a set of properties K of type T
DashboardTileTarget
CreateSchedulerTarget
Series
object
14 properties
2 required
SchedulerGsheetsOptions
object
5 properties
4 required
FormulaTableCalculation
TableCalculationTemplateType.WINDOW_FUNCTION
string
FilterGroupItem
ApiGithubDbtWriteBack
object
2 properties
2 required
DashboardSqlChartTileProperties
object
2 properties
2 required
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
Pick_SchedulerGoogleChatTarget.googleChatWebhook_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
UpdateVirtualViewPayload
DashboardTab
object
4 properties
3 required
BinType.CUSTOM_RANGE
string
Axis
object
7 properties
ChartKind.TABLE
string
Scheduler
Record_string.AnyType_
object
Construct a type with a set of properties K of type T
AndFilterGroup
object
2 properties
2 required
ChartKind.VERTICAL_BAR
string
DashboardChartTile
SchedulerOptions
VizBarChartConfig
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
ApiSuccessEmpty
object
2 properties
1 required
PartitionColumn
object
2 properties
2 required
SavedChartDAO
ChartType.CARTESIAN
string
DashboardTileTypes
string
BaseFilterRule_FilterOperator.number-or-string_
object
3 properties
2 required
TimeFrames
string
ConditionalFormattingWithValues_number-or-string_
SchedulerGoogleChatTarget
object
5 properties
5 required
ChartKind.PIE
string
FrameType
string
PivotReference
object
2 properties
1 required
FixedWidthBinDimension
object
7 properties
7 required
ValueLabelPositionOptions
string
DashboardTileTypes.LOOM
string
ColumnProperties
object
6 properties
MapChartType
string
GaugeChartConfig
object
2 properties
1 required
MapTileBackground
string
ConditionalFormattingConfigWithSingleColor
object
5 properties
3 required
Format
string
CustomDimension
Pick_LightdashUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
FieldId
string
ResolvedProjectColorPalette
object
5 properties
5 required
VizTableDisplay
object
CustomDimensionType.BIN
string
PieChartValueLabel
string
DashboardLoomTileProperties
object
2 properties
2 required
ConditionalFormattingWithCompareTarget_number-or-string_
BigNumberConfig
object
2 properties
1 required
DashboardFilters
object
3 properties
3 required
BinGroup
object
2 properties
2 required
EchartsLegend
object
12 properties
CartesianChartConfig
object
2 properties
1 required
SqlRunnerBody
object
2 properties
1 required
AdditionalMetric
object
23 properties
4 required
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
ApiWarehouseTableFields
object
2 properties
2 required
PieChartLegendPosition
string
DashboardMarkdownTile
TooltipSortBy
string
ApiGithubDbtWritePreview
object
2 properties
2 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
DashboardDataAppTile
NotificationFrequency
string
MapChart
object
26 properties
SchedulerRun
object
15 properties
15 required
Partial_CompleteCartesianChartLayout_
object
Make all properties in T optional
13 properties
Pick_Project.projectUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
FunnelChartConfig
object
2 properties
1 required
PieChart
object
14 properties
ChartType.TREEMAP
string
TreemapChart
object
10 properties
CartesianSeriesType.BAR
string
CartesianSeriesType
string
FilterGroup
OrFilterGroup
object
2 properties
2 required
DashboardTileTypes.SAVED_CHART
string
SchedulerBase
object
26 properties
19 required
MapHexbinValueBasis
string
UpdateSqlChart
object
2 properties
PromotedSpace
SortBy
array
SchedulerFormat
string
FunnelChartLegendPosition
string
ContentVerificationInfo
object
2 properties
2 required
Pick_SchedulerEmailTarget.recipient_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
BinRange
object
2 properties
DimensionOverrides
object
PromotionAction
string
TableCalculationTemplateType.RANK_IN_COLUMN
string
SchedulerCsvOptions
object
4 properties
2 required
GroupValueRule
object
2 properties
2 required
PivotChartLayout
object
5 properties
1 required
DashboardTileTypes.SQL_CHART
string
SortField
object
4 properties
2 required
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
GaugeSection
object
5 properties
3 required
Compact
string
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties
3 required
DashboardTileBase
CreateSqlChart
object
7 properties
6 required
ApiWarehouseTablesCatalog
object
2 properties
2 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
SeriesMetadata
object
1 property
1 required
ConditionalFormattingConfig
VizColumnsConfig
object
GroupValueMatchType
string
Omit_CreateSchedulerAndTargets.savedChartUuid-or-dashboardUuid-or-savedSqlUuid-or-createdBy_
Construct a type with the properties of T except for those in type K.
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
Pick_Dashboard.Exclude_keyofDashboard.inheritsFromOrgOrProject-or-access__
object
From T, pick a set of properties whose keys are in the union K
25 properties
19 required
DateGranularity
string
SchedulerImageOptions
object
1 property
CustomVisConfig
object
2 properties
1 required
VizTableConfig
EchartsGrid
object
7 properties
CartesianChartLayout
CustomBinDimension
VizBaseConfig
object
2 properties
2 required
VizPieChartDisplay
object
1 property
BigNumber
object
11 properties
ParameterValue
DimensionType
string
ChartType.GAUGE
string
CartesianChart
object
6 properties
2 required
ConditionalFormattingColorApplyTo
string
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
DashboardTileTypes.MARKDOWN
string
PieChartConfig
object
2 properties
1 required
PartitionType
string
MetricQuery
object
14 properties
7 required
ChartType.TABLE
string
PromotedApp
object
2 properties
2 required
ConditionalFormattingWithFilterOperator
TableCalculationType
string
SchedulerResourceType
string
ConditionalFormattingConfigWithColorRange
object
4 properties
3 required
ApiCreateVirtualView
object
2 properties
2 required
Filters
object
3 properties
SpaceSummaryBase
FunnelChartDataInput
string
SchedulerAndTargets
Required_CreateDashboardTileBase_
object
Make all properties in T required
7 properties
6 required
DashboardParameters
CreateVirtualViewPayload
object
4 properties
3 required
GaugeChart
object
9 properties
WindowFunctionType
string
LegendPlacement
string
High-level legend placement preset. Set to 'outsideRight' or 'outsideLeft' to render the legend beside the plot with reserved grid space. Undefined behaves lik…
SankeyChart
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lightdash 12
Other APIs Lightdash publishes across the network.
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 Exploring API
Lightdash Exports API
Lightdash Feature Flag API
#SQL runner
Where this information came from
This is an independent, third-party profile of Lightdash SQL runner 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.