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

Lightdash Pre-Aggregates API

The Pre-Aggregates API from Lightdash — 3 operation(s) for pre-aggregates.

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

This API exposes 4 operations across 3 paths, and defines 58 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

4 operations 3 paths 58 schemas 3 GET1 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
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Pre-Aggregates 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 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Pre-Aggregates 4
GET
/api/v2/projects/{projectUuid}/pre-aggregates/stats
Get pre-aggregate stats
getPreAggregateStats 6 params → 200default
GET
/api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit
Get dashboard pre-aggregate audit
getDashboardPreAggregateAudit 2 params → 200default
POST
/api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit
Run dashboard pre-aggregate audit
runDashboardPreAggregateAudit 2 params body → 200default
GET
/api/v2/projects/{projectUuid}/pre-aggregates/materializations
Get pre-aggregate materializations
getPreAggregateMaterializations 3 params → 200default

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are PreAggregateMaterializationSummary (15 properties), PreAggregateDailyStatResult (12 properties), MetricFilterRule (8 properties), FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_ (8 properties). Each schema is shown below with its type and property counts.

PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
DashboardFilterRule
PreAggregateMaterializationRole
object
2 properties 2 required
FieldId
string
DashboardTileTarget
ApiPreAggregateStatsResults
object
1 property 1 required
ResultColumns
TileIneligibleReason
string
Record_string.string-Array_
object
Construct a type with a set of properties K of type T
DashboardFieldTarget
object
4 properties 2 required
TilePreAggregateAuditMiss
object
8 properties 8 required
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
DashboardFilters
object
3 properties 3 required
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
DashboardPreAggregateAuditSummary
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…
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
ApiPreAggregateMaterializationsResults
object
1 property 1 required
TimeFrames
string
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties 3 required
FilterOperator
string
ApiRunDashboardPreAggregateAuditBody
object
1 property
TabAuditGroup
object
3 properties 3 required
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
KnexPaginateArgs
object
2 properties 2 required
TilePreAggregateAuditIneligible
object
5 properties 5 required
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
TilePreAggregateAuditHit
object
7 properties 7 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
PreAggregateMissReason.USER_BYPASS
string
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
ApiGetDashboardPreAggregateAuditResponse
object
2 properties 2 required
PreAggregateMatchMiss
DashboardTileTypes.SAVED_CHART
string
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
ApiGetPreAggregateStatsResponse
object
2 properties 2 required
PreAggregateDailyStatResult
object
12 properties 12 required
DashboardPreAggregateAudit
object
5 properties 5 required
TilePreAggregateAuditStatus
PreAggregateMaterializationTrigger
string
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
PreAggregateMaterializationWarning
ResultColumn
object
2 properties 2 required
ApiGetPreAggregateMaterializationsResponse
object
2 properties 2 required
PreAggregateMaterializationSummary
object
15 properties 15 required
PreAggregateMaterializationStatus
string
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
DimensionType
string
DashboardTileTypes
string
KnexPaginatedData_ApiPreAggregateStatsResults_
object
2 properties 1 required
Record_string.ResultColumn_
object
Construct a type with a set of properties K of type T
UserAttributeValueMap
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
KnexPaginatedData_ApiPreAggregateMaterializationsResults_
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-pre-aggregates-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
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
Where this information came from

This is an independent, third-party profile of Lightdash Pre-Aggregates 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.