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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightdash

Lightdash SQL runner API

The SQL runner API from Lightdash — 18 operation(s) for sql runner.

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightdash SQL runner 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 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.0.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.

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

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
getTables 1 param → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/fields
Get table fields
getTableFields 4 params → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/rundeprecated
Run SQL query
runSql 1 param body → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/runPivotQuerydeprecated
Run SQL pivot query
runSqlPivotQuery 1 param body → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/results/{fileId}deprecated
Get stored results
getLocalResults 2 params → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Get SQL chart
getSavedSqlChart 2 params → 200default
PATCH
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Update SQL chart
updateSqlChart 2 params body → 200default
DELETE
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}
Delete SQL chart
deleteSqlChart 2 params → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}
Get SQL chart by slug
getSavedSqlChartBySlug 2 params → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}/results-jobdeprecated
Get SQL chart results job
getSavedSqlResultsJob 2 params → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/results-jobdeprecated
Get SQL chart results job by UUID
getSavedSqlResultsJobByUuid 2 params → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved
Create SQL chart
createSqlChart 1 param body → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promote
Promote SQL chart
promoteSqlChart 2 params → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promoteDiff
Get SQL chart promotion diff
promoteSqlChartDiff 2 params → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/refresh-catalog
Refresh catalog cache
refreshSqlRunnerCatalog 1 param → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view
Create virtual view
createVirtualView 1 param body → 200default
PUT
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name}
Update virtual view
updateVirtualView 2 params body → 200default
DELETE
/api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name}
Delete virtual view
deleteVirtualView 2 params → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/preview
Preview write back
writeBackPreview 1 param body → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/pull-request
Create write back PR
writeBackCreatePr 1 param body → 200default
GET
/api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers
List SQL chart schedulers
getSqlChartSchedulers 2 params → 200default
POST
/api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers
Create SQL chart scheduler
createSqlChartScheduler 2 params body → 201default

Schemas 308

The contract defines 308 schemas that model the data the API accepts and returns. The most detailed are Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__ (26 properties), SchedulerBase (26 properties), MapChart (26 properties), Pick_Dashboard.Exclude_keyofDashboard.inheritsFromOrgOrProject-or-access__ (25 properties). Each schema is shown below with its type and property counts.

OrganizationMemberRole
string
ResolvedProjectColorPalette
object
5 properties 5 required
MapHexbinSizingMode
string
CreateSchedulerTarget
MarkLine
object
4 properties 1 required
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
FilterGroup
PivotReference
object
2 properties 1 required
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
DashboardChartTileProperties
object
2 properties 2 required
VizTableConfig
ProjectMemberRole
string
TreemapChart
object
10 properties
DashboardDataAppTile
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
CartesianSeriesType
string
FrameBoundaryType
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
SchedulerCsvOptions
object
4 properties 2 required
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
DashboardFilterRule
Pick_LightdashUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
SqlRunnerBody
object
2 properties 1 required
BinRange
object
2 properties
FilterGroupItem
PivotValue
object
2 properties 2 required
ApiGithubDbtWritePreview
object
2 properties 2 required
MetricOverrides
object
SortBy
array
SchedulerBase
object
26 properties 19 required
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…
Filters
object
3 properties
AdditionalMetric
object
23 properties 4 required
ApiSqlChart
object
2 properties 2 required
FrameBoundary
object
2 properties 1 required
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
MetricQuery
object
14 properties 7 required
DashboardHeadingTile
PieChartValueLabel
string
ChartKind.VERTICAL_BAR
string
DashboardTile
Partial_CompleteCartesianChartLayout_
object
Make all properties in T optional
13 properties
PieChart
object
14 properties
GroupValueRule
object
2 properties 2 required
MapFieldConfig
object
2 properties
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
CartesianChartLayout
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
TimeFrames
string
Record_string.never_
object
Construct a type with a set of properties K of type T
PivotChartLayout
object
5 properties 1 required
SqlTableCalculation
CreateSchedulerAndTargetsWithoutIds
FixedNumberBinDimension
object
7 properties 7 required
ApiGithubDbtWriteBack
object
2 properties 2 required
ChartType.SANKEY
string
GaugeSection
object
5 properties 3 required
Record_string.DashboardParameterValue_
object
Construct a type with a set of properties K of type T
DashboardDAO
MapChartConfig
object
2 properties 1 required
VizCartesianChartConfig
GroupByColumn
object
1 property 1 required
ApiWarehouseTablesCatalog
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
Series
object
14 properties 2 required
CustomFormat
object
9 properties 1 required
ChartKind.PIE
string
ChartType.FUNNEL
string
TableCalculationTemplate
ChartType.BIG_NUMBER
string
TemplateTableCalculation
PromotedSpace
DashboardSqlChartTileProperties
object
2 properties 2 required
ConditionalFormattingConfig
ChartType.GAUGE
string
ValuesColumn
object
2 properties 2 required
BigNumberConfig
object
2 properties 1 required
ApiWarehouseTableFields
object
2 properties 2 required
VizIndexType
string
ConditionalFormattingConfigWithColorRange
object
4 properties 3 required
ApiSqlRunnerPivotQueryPayload
LogCounts
object
5 properties 5 required
FunnelChartLegendPosition
string
VizColumnsConfig
object
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
Required_CreateDashboardTileBase_
object
Make all properties in T required
7 properties 6 required
CustomDimension
DashboardParameterValue
object
2 properties 2 required
VizLineChartConfig
ChartType.TABLE
string
MapTileBackground
string
SpaceMemberRole
string
UpdateSqlChart
object
2 properties
CartesianSeriesType.BAR
string
ChartType.PIE
string
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
Record_string.unknown_
object
Construct a type with a set of properties K of type T
CustomGroupBinDimension
object
7 properties 7 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…
DashboardLoomTileProperties
object
2 properties 2 required
PartitionType
string
XAxis
ChartType.CUSTOM
string
PullRequestCreated
object
2 properties 2 required
ChartType.MAP
string
SchedulerRunStatus
string
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…
CartesianChartConfig
object
2 properties 1 required
GaugeChart
object
9 properties
ConditionalFormattingMinMax_number-or-auto_
object
2 properties 2 required
GaugeChartConfig
object
2 properties 1 required
ColumnProperties
object
6 properties
MapChartLocation
string
TableChart
object
12 properties
UpdateUnversionedSqlChart
object
3 properties 3 required
StackType
string
UpdateVersionedSqlChart
object
3 properties 3 required
Partial_CompleteEChartsConfig_
object
Make all properties in T optional
10 properties
CartesianChartDisplay
object
5 properties
PieChartLegendPosition
string
DimensionType
string
ThresholdOptions
object
3 properties 3 required
UpdatedByUser
object
3 properties 3 required
SchedulerImageOptions
object
1 property
Pick_Organization.organizationUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
VizAggregationOptions
string
FrameClause
object
3 properties 2 required
EchartsLegend
object
12 properties
VizBaseConfig
object
2 properties 2 required
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties 3 required
SqlChartScheduler
MapChartType
string
BaseFilterRule_FilterOperator.number-or-string_
object
3 properties 2 required
MarkLineData
object
9 properties 1 required
VizPieChartConfig
Compact
string
TableCalculationTemplateType.RUNNING_TOTAL
string
Pick_Project.projectUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
ThresholdOperator
string
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
BinType.CUSTOM_GROUP
string
TableCalculationBase
object
5 properties 2 required
TableChartConfig
object
2 properties 1 required
DashboardTileTypes.DATA_APP
string
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
ComparisonFormatTypes
string
SqlChart
object
20 properties 20 required
WarehouseTablesCatalog
object
CartesianSeriesType.LINE
string
DashboardHeadingTileProperties
object
2 properties 2 required
CustomFormatType
string
SchedulerOptions
DashboardTileTypes.SAVED_CHART
string
Scheduler
Record_string.AnyType_
object
Construct a type with a set of properties K of type T
CustomSqlDimension
object
6 properties 6 required
AndFilterGroup
object
2 properties 2 required
CustomDimensionType.SQL
string
DashboardConfig
object
6 properties 1 required
ConditionalFormattingWithFilterOperator
Pick_SchedulerEmailTarget.recipient_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
DateGranularity
string
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
Pick_SchedulerMsTeamsTarget.webhook_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
VizBarChartConfig
CustomVis
object
1 property
ApiUpdateSqlChart
object
2 properties 2 required
OrFilterGroup
object
2 properties 2 required
ApiCreateSqlChart
object
2 properties 2 required
VizColumn
object
2 properties 1 required
DashboardLoomTile
VizColumnConfig
object
8 properties 4 required
Omit_CreateSchedulerAndTargets.savedChartUuid-or-dashboardUuid-or-savedSqlUuid-or-createdBy_
Construct a type with the properties of T except for those in type K.
TableCalculationType
string
SpaceSummaryBase
ApiJobScheduledResponse
object
2 properties 2 required
DashboardTab
object
4 properties 3 required
ChartKind.LINE
string
SchedulerResourceType
string
SavedChartDAO
SchedulerFormat
string
SchedulerGsheetsOptions
object
5 properties 4 required
DashboardMarkdownTileProperties
object
2 properties 2 required
MapHexbinAggregation
string
AppScheduler
ChartType.CARTESIAN
string
DashboardParameters
SchedulerEmailTarget
object
5 properties 5 required
PromotedSqlChart
object
8 properties 8 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
DashboardTileTypes.HEADING
string
FunnelChartDataInput
string
DashboardTileTypes.SQL_CHART
string
ChartKind
string
SeriesMetadata
object
1 property 1 required
ChartKind.TABLE
string
MetricType
string
PivotIndexColum
object
2 properties 2 required
Axis
object
7 properties
TableCalculation
SankeyChart
object
6 properties
FilterRule
object
8 properties 3 required
PromotedDashboard
PromotedApp
object
2 properties 2 required
PromotedChart
DashboardScheduler
ConditionalFormattingConfigWithSingleColor
object
5 properties 3 required
Record_string.ColumnProperties_
object
Construct a type with a set of properties K of type T
GroupValueMatchType
string
ParameterValue
ParametersValuesMap
WindowFunctionType
string
FunnelChartConfig
object
2 properties 1 required
ChartConfig
ApiPromotionChangesResponse
object
2 properties 2 required
Omit_Dashboard.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
DashboardChartTile
ValueLabelPositionOptions
string
ConditionalFormattingWithCompareTarget_number-or-string_
BinType.FIXED_WIDTH
string
SchedulerAndTargets
FilterOperator
string
CustomDimensionType.BIN
string
Record_string.string_
object
Construct a type with a set of properties K of type T
Format
string
ConditionalFormattingColorApplyTo
string
SchedulerSlackTarget
object
5 properties 5 required
DashboardTileTarget
PivotConfiguration
object
9 properties 1 required
RowLimit
object
3 properties 3 required
Pick_Metric.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
DashboardTileTypes.LOOM
string
TreemapChartConfig
object
2 properties 1 required
NotificationFrequency
string
FixedWidthBinDimension
object
7 properties 7 required
MapChart
object
26 properties
Pick_Explore.name_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
DimensionOverrides
object
BinType.FIXED_NUMBER
string
DashboardTileTypes
string
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
UpdateVirtualViewPayload
SpaceAccess
object
6 properties 3 required
DashboardSqlChartTile
FormulaTableCalculation
FrameType
string
FieldId
string
SortByDirection
string
BigNumber
object
11 properties
Pick_SchedulerGoogleChatTarget.googleChatWebhook_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
SchedulerRun
object
15 properties 15 required
SchedulerJobStatus
string
FieldTarget
object
1 property 1 required
ApiCreateVirtualView
object
2 properties 2 required
PartitionColumn
object
2 properties 2 required
PromotionChanges
object
5 properties 3 required
DashboardMarkdownTile
CompactOrAlias
CustomVisConfig
object
2 properties 1 required
BinGroup
object
2 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
ChartScheduler
DashboardTileTypes.MARKDOWN
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
TooltipSortBy
string
Record_string.SeriesMetadata_
object
Construct a type with a set of properties K of type T
SortField
object
4 properties 2 required
NumberSeparator
string
SchedulerPdfOptions
CustomBinDimension
VizTableDisplay
object
SankeyChartConfig
object
2 properties 1 required
SchedulerMsTeamsTarget
object
5 properties 5 required
DashboardFilters
object
3 properties 3 required
AxisSide
number
DashboardTileBase
XAxisSortType
string
SchedulerGoogleChatTarget
object
5 properties 5 required
AllVizChartConfig
DashboardDataAppTileProperties
object
2 properties 2 required
BinType.CUSTOM_RANGE
string
WarehouseTableSchema
object
VizSortBy
object
4 properties 2 required
SqlRunnerPivotQueryBody
PromotionAction
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
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
TableCalculationTemplateType.RANK_IN_COLUMN
string
Omit_SavedChart.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
ConditionalFormattingWithValues_number-or-string_
ChartType.TREEMAP
string
DashboardFieldTarget
object
4 properties 2 required
CreateSqlChart
object
7 properties 6 required
ConditionalFormattingColorRange
object
2 properties 2 required
PieChartConfig
object
2 properties 1 required
FunnelChart
object
8 properties
VizPieChartDisplay
object
1 property
EchartsGrid
object
7 properties
CartesianChart
object
6 properties 2 required
CreateVirtualViewPayload
object
4 properties 3 required
FunnelChartLabelPosition
string
EChartsConfig
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
MapHexbinValueBasis
string
ContentVerificationInfo
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-sql-runner-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
AE Profile APIs.io
Lightdash Bulk action API
AE Profile APIs.io
Lightdash Catalog API
AE Profile APIs.io
Lightdash Changesets API
AE Profile APIs.io
Lightdash Charts API
AE Profile APIs.io
Lightdash Comments API
AE Profile APIs.io
Lightdash Content API
AE Profile APIs.io
Lightdash Custom Roles API
AE Profile APIs.io
Lightdash Dashboards API
AE Profile APIs.io
Lightdash Explorer API
AE Profile APIs.io
Lightdash Exploring API
AE Profile APIs.io
Lightdash Exports API
AE Profile APIs.io
#SQL runner
← Back to L APIs
API Details
ID
lightdash:lightdash-sql-runner-api
Base URL
https://app.lightdash.cloud
Docs
https://docs.lightdash.com/api-reference/v1/introduction
Provider
Lightdash
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightdash-sql-runner-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightdash-sql-runner-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

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.