Lightdash Charts API
The Charts API from Lightdash — 15 operation(s) for charts.
Lightdash Charts 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 Charts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes 18 operations across 15 paths, and defines 292 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.
Requests are made against a single base URL, /.
18 operations
15 paths
292 schemas
2 DELETE7 GET9 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Lightdash Charts 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 18
Across 15 paths, the API surfaces 18 operations — 2 DELETE, 7 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.
Charts 18
POST
/api/v1/saved/{chartUuid}/resultsdeprecated
Run chart query
POST
/api/v1/saved/{chartUuid}/chart-and-resultsdeprecated
Get chart and results
GET
/api/v1/saved/{chartUuid}/history
Get chart version history
GET
/api/v1/saved/{chartUuid}/version/{versionUuid}
Get chart version
POST
/api/v1/saved/{chartUuid}/version/{versionUuid}/resultsdeprecated
Get chart version results
POST
/api/v1/saved/{chartUuid}/rollback/{versionUuid}
Rollback chart to version
POST
/api/v1/saved/{chartUuid}/calculate-totaldeprecated
Calculate total from saved chart
POST
/api/v1/saved/{chartUuid}/promote
Promote chart
GET
/api/v1/saved/{chartUuid}/promoteDiff
Get chart promotion diff
GET
/api/v1/saved/{chartUuid}/schedulersdeprecated
List saved chart schedulers
POST
/api/v1/saved/{chartUuid}/schedulers
Create saved chart scheduler
POST
/api/v1/saved/{chartUuid}/export
Export chart image
POST
/api/v1/saved/{chartUuid}/verification
Verify chart
DELETE
/api/v1/saved/{chartUuid}/verification
Unverify chart
GET
/api/v2/saved/{chartUuid}/schedulers
List chart schedulers
GET
/api/v2/saved/{chartUuid}/schedulers/{schedulerUuid}/runs
List chart scheduler runs
GET
/api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug}
Get chart
DELETE
/api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug}
Delete chart
Schemas 292
The contract defines 292 schemas that model the data the API accepts and returns. The most detailed are Metric (33 properties), SavedChart (28 properties), Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__ (26 properties), SchedulerBase (26 properties). Each schema is shown below with its type and property counts.
ConditionalFormattingWithFilterOperator
DateZoom
object
2 properties
OrganizationMemberRole
string
KnexPaginatedData_SchedulerAndTargets-Array_
object
2 properties
1 required
FieldUrl
object
2 properties
2 required
DashboardTileTarget
DateGranularity
string
ChartType.TABLE
string
ResolvedProjectColorPalette
object
5 properties
5 required
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
MapTileBackground
string
MapHexbinSizingMode
string
MarkLine
object
4 properties
1 required
Metric
object
33 properties
8 required
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
ApiSuccess_KnexPaginatedData_SchedulerRun-Array__
object
2 properties
2 required
ApiRunQueryResponse
object
2 properties
2 required
FieldType.METRIC
string
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
OrFilterGroup
object
2 properties
2 required
FixedWidthBinDimension
object
7 properties
7 required
ApiGetChartVersionResponse
object
2 properties
2 required
ChartVersion
object
5 properties
5 required
MapChart
object
26 properties
DashboardChartTileProperties
object
2 properties
2 required
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
ChartType.PIE
string
ApiCreateSavedChartSchedulerResponse
object
2 properties
2 required
ProjectMemberRole
string
DimensionOverrides
object
BinType.FIXED_NUMBER
string
DashboardLoomTile
TreemapChart
object
10 properties
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
DashboardDataAppTile
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
CartesianSeriesType
string
TableCalculationType
string
CustomGroupBinDimension
object
7 properties
7 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
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
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
DashboardLoomTileProperties
object
2 properties
2 required
DashboardTab
object
4 properties
3 required
SpaceSummaryBase
FormulaTableCalculation
DashboardSqlChartTile
SchedulerResourceType
string
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
DashboardFilterRule
FrameType
string
ApiGetChartHistoryResponse
object
2 properties
2 required
FieldId
string
XAxis
ChartType.CUSTOM
string
BigNumber
object
11 properties
SchedulerRunStatus
string
ChartType.MAP
string
CacheMetadata
object
5 properties
1 required
DefaultTimeDimension
object
2 properties
2 required
Pick_LightdashUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
SavedChartDAO
SchedulerFormat
string
SchedulerRun
object
15 properties
15 required
ApiContentVerificationDeleteResponse
object
2 properties
1 required
SchedulerGsheetsOptions
object
5 properties
4 required
SchedulerJobStatus
string
MapHexbinAggregation
string
DashboardMarkdownTileProperties
object
2 properties
2 required
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…
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
CartesianChartConfig
object
2 properties
1 required
MetricOverrides
object
AppScheduler
ChartType.CARTESIAN
string
GaugeChart
object
9 properties
SchedulerBase
object
26 properties
19 required
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
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
PreAggregateMissReason.USER_BYPASS
string
ColumnProperties
object
6 properties
MapChartLocation
string
Filters
object
3 properties
PreAggregateMatchMiss
TableChart
object
12 properties
DashboardParameters
PromotionChanges
object
5 properties
3 required
SchedulerEmailTarget
object
5 properties
5 required
DashboardMarkdownTile
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
Source
object
4 properties
3 required
ChartScheduler
FrameBoundary
object
2 properties
1 required
PieChartLegendPosition
string
DimensionType
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
DashboardTileTypes.MARKDOWN
string
ThresholdOptions
object
3 properties
3 required
DashboardTileTypes.HEADING
string
FunnelChartDataInput
string
TooltipSortBy
string
DashboardTileTypes.SQL_CHART
string
SeriesMetadata
object
1 property
1 required
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
Record_string.number_
object
Construct a type with a set of properties K of type T
ChartKind
string
SortField
object
4 properties
2 required
MetricType
string
PieChartValueLabel
string
DashboardHeadingTile
NumberSeparator
string
SchedulerPdfOptions
SchedulerImageOptions
object
1 property
CustomBinDimension
FiltersResponse
object
3 properties
Partial_CompleteCartesianChartLayout_
object
Make all properties in T optional
13 properties
DashboardTile
FilterGroupResponse
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
ApiSavedChartResponse
object
2 properties
2 required
TableCalculationTemplateType.WINDOW_FUNCTION
string
ApiCalculateTotalResponse
object
2 properties
2 required
Axis
object
7 properties
CartesianChartLayout
ApiSavedChartSchedulersResponse
object
2 properties
2 required
SchedulerMsTeamsTarget
object
5 properties
5 required
DashboardFilters
object
3 properties
3 required
DashboardTileBase
KnexPaginatedData_SchedulerRun-Array_
object
2 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…
TableCalculation
ApiSuccessEmpty
object
2 properties
1 required
TimeFrames
string
XAxisSortType
string
FieldType
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
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
SqlTableCalculation
PromotedDashboard
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
DashboardDataAppTileProperties
object
2 properties
2 required
Field
object
20 properties
8 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FixedNumberBinDimension
object
7 properties
7 required
SqlChartScheduler
BinType.CUSTOM_RANGE
string
PromotedApp
object
2 properties
2 required
DashboardScheduler
ChartType.SANKEY
string
ConditionalFormattingConfigWithSingleColor
object
5 properties
3 required
PromotedChart
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
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
ChartHistory
object
1 property
1 required
ParametersValuesMap
BinType.CUSTOM_GROUP
string
Series
object
14 properties
2 required
CustomFormat
object
9 properties
1 required
ChartType.FUNNEL
string
WindowFunctionType
string
PromotionAction
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
TableCalculationTemplate
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
TableChartConfig
object
2 properties
1 required
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
DashboardTileTypes.DATA_APP
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_
ApiPromoteChartResponse
object
2 properties
2 required
ConditionalFormattingWithValues_number-or-string_
ChartType.TREEMAP
string
PromotedSpace
DashboardFieldTarget
object
4 properties
2 required
BinType.FIXED_WIDTH
string
DashboardSqlChartTileProperties
object
2 properties
2 required
ConditionalFormattingConfig
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
ConditionalFormattingColorRange
object
2 properties
2 required
PieChartConfig
object
2 properties
1 required
SourcePosition
object
2 properties
2 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
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
BigNumberConfig
object
2 properties
1 required
CustomDimensionType.BIN
string
EchartsGrid
object
7 properties
CustomFormatType
string
SchedulerOptions
SavedChart
object
28 properties
22 required
CartesianChart
object
6 properties
2 required
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
DashboardTileTypes.SAVED_CHART
string
ApiSavedChartPaginatedSchedulersResponse
object
2 properties
2 required
Record_string.Item-or-AdditionalMetric_
object
Construct a type with a set of properties K of type T
MetricQueryResponse
object
10 properties
7 required
ApiSchedulerRunsResponse
Record_string.string_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
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
DashboardTileTypes
string
CustomSqlDimension
object
6 properties
6 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
ApiExportChartImageResponse
object
2 properties
2 required
Required_CreateDashboardTileBase_
object
Make all properties in T required
7 properties
6 required
Format
string
CustomDimension
EChartsConfig
DashboardParameterValue
object
2 properties
2 required
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
More from Lightdash 12
Other APIs Lightdash publishes across the network.
Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets 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
#Charts
Where this information came from
This is an independent, third-party profile of Lightdash Charts 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.