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 Dashboards API

The Dashboards API from Lightdash — 11 operation(s) for dashboards.

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightdash Dashboards 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 Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

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

Requests are made against a single base URL, /.

15 operations 11 paths 276 schemas 2 DELETE8 GET1 PATCH4 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
Contact
Lightdash Support
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Dashboards 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 15

Across 11 paths, the API surfaces 15 operations — 2 DELETE, 8 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboards 15
POST
/api/v1/dashboards/{dashboardUuid}/promote
Promote dashboard
promoteDashboard 1 param → 200default
GET
/api/v1/dashboards/{dashboardUuid}/promoteDiff
Get dashboard promotion diff
promoteDashboardDiff 1 param → 200default
GET
/api/v1/dashboards/{dashboardUuid}/history
Get dashboard history
getDashboardHistory 1 param → 200default
GET
/api/v1/dashboards/{dashboardUuid}/version/{versionUuid}
Get dashboard version
getDashboardVersion 2 params → 200default
POST
/api/v1/dashboards/{dashboardUuid}/rollback/{versionUuid}
Rollback dashboard version
postDashboardVersionRollback 2 params → 200default
GET
/api/v1/dashboards/{dashboardUuid}/schedulersdeprecated
List dashboard schedulers
getDashboardSchedulers 1 param → 200default
POST
/api/v1/dashboards/{dashboardUuid}/schedulers
Create dashboard scheduler
createDashboardScheduler 1 param → 200default
POST
/api/v1/dashboards/{dashboardUuid}/verification
Verify dashboard
verifyDashboard 1 param → 200default
DELETE
/api/v1/dashboards/{dashboardUuid}/verification
Unverify dashboard
unverifyDashboard 1 param → 200default
GET
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Get dashboard
getProjectDashboard 2 params → 200default
PATCH
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Update dashboard
updateProjectDashboard 2 params body → 200default
DELETE
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Delete dashboard
deleteProjectDashboard 2 params → 200default
GET
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}/comments
Get comments
getProjectDashboardComments 3 params → 200default
GET
/api/v2/dashboards/{dashboardUuid}/schedulers
List dashboard schedulers
getDashboardSchedulers 5 params → 200default
GET
/api/v2/dashboards/{dashboardUuid}/schedulers/{schedulerUuid}/runs
List dashboard scheduler runs
getDashboardSchedulerRuns 9 params → 200default

Schemas 276

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

ConditionalFormattingWithFilterOperator
OrganizationMemberRole
string
CreateDashboardChartTile
KnexPaginatedData_SchedulerAndTargets-Array_
object
2 properties 1 required
DashboardTileTarget
DateGranularity
string
ChartType.TABLE
string
DashboardHistory
object
1 property 1 required
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
MapTileBackground
string
ResolvedProjectColorPalette
object
5 properties 5 required
MapHexbinSizingMode
string
Pick_CreateDashboard.tiles-or-filters-or-parameters-or-updatedByUser-or-tabs-or-config_
object
From T, pick a set of properties whose keys are in the union K
6 properties 2 required
MarkLine
object
4 properties 1 required
CreateDashboardMarkdownTile
ApiSuccess_KnexPaginatedData_SchedulerRun-Array__
object
2 properties 2 required
SpaceMemberRole
string
FilterGroup
RowLimit
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
CustomVis
object
1 property
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
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
NotificationFrequency
string
ApiGetDashboardHistoryResponse
object
2 properties 2 required
OrFilterGroup
object
2 properties 2 required
FixedWidthBinDimension
object
7 properties 7 required
MapChart
object
26 properties
DashboardChartTileProperties
object
2 properties 2 required
ChartType.PIE
string
ProjectMemberRole
string
DimensionOverrides
object
BinType.FIXED_NUMBER
string
DashboardLoomTile
TreemapChart
object
10 properties
DashboardDataAppTile
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
DashboardVersionedFields
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
DashboardTileTypes
string
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
TableCalculationType
string
CustomGroupBinDimension
object
7 properties 7 required
CartesianSeriesType
string
ApiDashboardResponse
object
2 properties 2 required
FrameBoundaryType
string
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…
SchedulerCsvOptions
object
4 properties 2 required
SpaceAccess
object
6 properties 3 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
DashboardLoomTileProperties
object
2 properties 2 required
DashboardTab
object
4 properties 3 required
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
DashboardSqlChartTile
FormulaTableCalculation
SchedulerResourceType
string
Pick_CreateDashboard.name-or-description-or-spaceUuid-or-colorPaletteUuid_
object
From T, pick a set of properties whose keys are in the union K
4 properties 1 required
DashboardFilterRule
FrameType
string
FieldId
string
XAxis
ChartType.CUSTOM
string
Pick_UpdatedByUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
3 properties 3 required
BigNumber
object
11 properties
SchedulerRunStatus
string
ChartType.MAP
string
Pick_LightdashUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
CreateDashboardLoomTile
SavedChartDAO
SchedulerFormat
string
SchedulerRun
object
15 properties 15 required
ApiContentVerificationDeleteResponse
object
2 properties 1 required
SchedulerGsheetsOptions
object
5 properties 4 required
DashboardMarkdownTileProperties
object
2 properties 2 required
SchedulerJobStatus
string
MapHexbinAggregation
string
BinRange
object
2 properties
FilterGroupItem
FieldTarget
object
1 property 1 required
PivotValue
object
2 properties 2 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…
ApiDashboardPaginatedSchedulersResponse
object
2 properties 2 required
CartesianChartConfig
object
2 properties 1 required
MetricOverrides
object
AppScheduler
ChartType.CARTESIAN
string
GaugeChart
object
9 properties
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…
ConditionalFormattingMinMax_number-or-auto_
object
2 properties 2 required
GaugeChartConfig
object
2 properties 1 required
ColumnProperties
object
6 properties
MapChartLocation
string
Filters
object
3 properties
TableChart
object
12 properties
DashboardVersionSummary
object
4 properties 4 required
DashboardParameters
PromotionChanges
object
5 properties 3 required
DashboardMarkdownTile
SchedulerEmailTarget
object
5 properties 5 required
CompactOrAlias
CustomVisConfig
object
2 properties 1 required
BinGroup
object
2 properties 2 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
AdditionalMetric
object
23 properties 4 required
Partial_CompleteEChartsConfig_
object
Make all properties in T optional
10 properties
ChartScheduler
FrameBoundary
object
2 properties 1 required
DashboardTileTypes.MARKDOWN
string
DimensionType
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
PieChartLegendPosition
string
DashboardTileTypes.HEADING
string
ThresholdOptions
object
3 properties 3 required
DashboardVersion
FunnelChartDataInput
string
DashboardTileTypes.SQL_CHART
string
TooltipSortBy
string
ChartKind
string
UpdatedByUser
object
3 properties 3 required
MetricQuery
object
14 properties 7 required
Record_string.SeriesMetadata_
object
Construct a type with a set of properties K of type T
SeriesMetadata
object
1 property 1 required
CreateDashboardSqlChartTile
CreateDashboardDataAppTile
SortField
object
4 properties 2 required
DashboardHeadingTile
MetricType
string
PieChartValueLabel
string
NumberSeparator
string
SchedulerPdfOptions
SchedulerImageOptions
object
1 property
CustomBinDimension
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
FrameClause
object
3 properties 2 required
EchartsLegend
object
12 properties
SankeyChartConfig
object
2 properties 1 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
ApiDashboardSchedulersResponse
object
2 properties 2 required
TableCalculationTemplateType.WINDOW_FUNCTION
string
Comment
object
10 properties 8 required
Axis
object
7 properties
SpaceSummaryBase
CartesianChartLayout
SchedulerMsTeamsTarget
object
5 properties 5 required
DashboardFilters
object
3 properties 3 required
DashboardTileBase
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…
KnexPaginatedData_SchedulerRun-Array_
object
2 properties 1 required
ApiSuccessEmpty
object
2 properties 1 required
TableCalculation
TimeFrames
string
XAxisSortType
string
SankeyChart
object
6 properties
Record_string.never_
object
Construct a type with a set of properties K of type T
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties 3 required
FilterRule
object
8 properties 3 required
SchedulerGoogleChatTarget
object
5 properties 5 required
PromotedDashboard
SqlTableCalculation
DashboardDataAppTileProperties
object
2 properties 2 required
ApiGetDashboardVersionResponse
object
2 properties 2 required
Pick_UpdatedByUser.userUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
PromotedApp
object
2 properties 2 required
SqlChartScheduler
PromotedChart
BinType.CUSTOM_RANGE
string
DashboardScheduler
FixedNumberBinDimension
object
7 properties 7 required
ConditionalFormattingConfigWithSingleColor
object
5 properties 3 required
ChartType.SANKEY
string
MapChartType
string
BaseFilterRule_FilterOperator.number-or-string_
object
3 properties 2 required
MarkLineData
object
9 properties 1 required
Record_string.ColumnProperties_
object
Construct a type with a set of properties K of type T
GroupValueMatchType
string
Dashboard
object
27 properties 21 required
Compact
string
GaugeSection
object
5 properties 3 required
Record_string.DashboardParameterValue_
object
Construct a type with a set of properties K of type T
DashboardDAO
ParameterValue
TableCalculationTemplateType.RUNNING_TOTAL
string
MapChartConfig
object
2 properties 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
PromotionAction
string
ParametersValuesMap
BinType.CUSTOM_GROUP
string
Series
object
14 properties 2 required
CustomFormat
object
9 properties 1 required
ChartType.FUNNEL
string
WindowFunctionType
string
FunnelChartConfig
object
2 properties 1 required
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
ChartConfig
TableCalculationBase
object
5 properties 2 required
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
TableCalculationTemplate
TableChartConfig
object
2 properties 1 required
DashboardTileTypes.DATA_APP
string
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
TableCalculationTemplateType.RANK_IN_COLUMN
string
ChartType.BIG_NUMBER
string
TemplateTableCalculation
Omit_SavedChart.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
ComparisonFormatTypes
string
ConditionalFormattingWithCompareTarget_number-or-string_
ConditionalFormattingWithValues_number-or-string_
ChartType.TREEMAP
string
PromotedSpace
DashboardSqlChartTileProperties
object
2 properties 2 required
DashboardFieldTarget
object
4 properties 2 required
BinType.FIXED_WIDTH
string
UpdateDashboard
ApiCreateDashboardSchedulerResponse
object
2 properties 2 required
DashboardUnversionedFields
ConditionalFormattingConfig
ConditionalFormattingColorRange
object
2 properties 2 required
PieChartConfig
object
2 properties 1 required
ChartType.GAUGE
string
SchedulerAndTargets
DashboardHeadingTileProperties
object
2 properties 2 required
FilterOperator
string
ApiContentVerificationResponse
object
2 properties 2 required
KnexPaginateArgs
object
2 properties 2 required
FunnelChart
object
8 properties
BigNumberConfig
object
2 properties 1 required
CustomDimensionType.BIN
string
EchartsGrid
object
7 properties
CustomFormatType
string
SchedulerOptions
CartesianChart
object
6 properties 2 required
ChartVersionDifference
object
5 properties 3 required
DashboardTileTypes.SAVED_CHART
string
Pick_ChartVersion.chartUuid-or-versionUuid-or-createdAt-or-createdBy_
object
From T, pick a set of properties whose keys are in the union K
4 properties 4 required
ApiPromoteDashboardResponse
object
2 properties 2 required
ApiSchedulerRunsResponse
Record_string.string_
object
Construct a type with a set of properties K of type T
Scheduler
ConditionalFormattingConfigWithColorRange
object
4 properties 3 required
LogCounts
object
5 properties 5 required
Record_string.AnyType_
object
Construct a type with a set of properties K of type T
CreateDashboardHeadingTile
CustomSqlDimension
object
6 properties 6 required
CreateDashboardTileBase
object
7 properties 5 required
ApiGetComments
object
2 properties 2 required
FunnelChartLabelPosition
string
AndFilterGroup
object
2 properties 2 required
FunnelChartLegendPosition
string
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
Format
string
CustomDimension
DashboardParameterValue
object
2 properties 2 required
EChartsConfig
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
CustomDimensionType.SQL
string
MapHexbinValueBasis
string
ChartVersionSummary
ConditionalFormattingColorApplyTo
string
ContentVerificationInfo
object
2 properties 2 required
SchedulerSlackTarget
object
5 properties 5 required
DashboardConfig
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-dashboards-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 Explorer API
AE Profile APIs.io
Lightdash Exploring API
AE Profile APIs.io
Lightdash Exports API
AE Profile APIs.io
Lightdash Feature Flag API
AE Profile APIs.io
#Dashboards
← Back to L APIs
API Details
ID
lightdash:lightdash-dashboards-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-dashboards-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightdash-dashboards-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 Dashboards 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.