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

The Metrics API from Lightdash — 2 operation(s) for metrics.

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

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

Requests are made against a single base URL, /.

2 operations 2 paths 35 schemas 2 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 Metrics 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 2

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

Metrics 2
POST
/api/v1/projects/{projectUuid}/metricsExplorer/{explore}/{metric}/runMetricTotal
Run metric total query
runMetricTotal 7 params body → 200default
POST
/api/v1/projects/{projectUuid}/metricsExplorer/{explore}/{metric}/compileMetricTotalQuery
Compile metric total query
compileMetricTotalQuery 7 params body → 200default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Dimension (37 properties), Metric (33 properties), CustomFormat (9 properties), MetricFilterRule (8 properties). Each schema is shown below with its type and property counts.

MetricWithAssociatedTimeDimension
CustomFormat
object
9 properties 1 required
MetricType
string
FieldType.DIMENSION
string
FieldCompilationError
object
Error information stored on a field when compilation fails but partial compilation mode is enabled.
1 property 1 required
NumberSeparator
string
FieldUrl
object
2 properties 2 required
MetricTotalResults
object
3 properties 3 required
Dimension
object
37 properties 8 required
MetricTotalComparisonType
string
DimensionType.TIMESTAMP
string
DefaultTimeDimension
object
2 properties 2 required
Metric
object
33 properties 8 required
FieldType.METRIC
string
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…
SourcePosition
object
2 properties 2 required
ApiMetricsExplorerTotalResults
object
2 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
TimeFrames
string
Record_string.Record_string.string-or-string-Array__
object
Construct a type with a set of properties K of type T
FilterOperator
string
CompiledProperties
object
7 properties 1 required
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
CustomFormatType
string
ApiCompiledQueryResults
object
4 properties 2 required
CompactOrAlias
DimensionType.DATE
string
Record_string.string_
object
Construct a type with a set of properties K of type T
Compact
string
Source
object
4 properties 3 required
DimensionType
string
CompiledDimension
Format
string
CompiledMetric
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-metrics-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 Metrics 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.