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

The Integrations API from Lightdash — 10 operation(s) for integrations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

Requests are made against a single base URL, /.

11 operations 10 paths 73 schemas 1 DELETE8 GET1 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 Integrations 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 11

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

Integrations 11
GET
/api/v1/slack/channels
Get Slack channels
getSlackChannels 6 params → 200default
GET
/api/v1/slack/channels/{channelId}
Lookup channel
getSlackChannelById 1 param → 200default
PUT
/api/v1/slack/custom-settings
Update Slack custom settings
UpdateCustomSettings body → 200default
GET
/api/v1/slack/is-authenticated
Check Slack OpenID link status
IsSlackOpenIdLinked → 200default
GET
/api/v1/slack
Get Slack installation
getSlackInstallation → 200default
DELETE
/api/v1/slack
Delete Slack installation
deleteSlackInstall → 200default
GET
/api/v1/slack/image/{nanoId}
Get Slack image
getSlackImage → 200default
GET
/api/v1/slack/preview/{id}
Get Slack preview
getSlackPreview 1 param → 302default
GET
/api/v1/slack/install
Install Slack
installSlack → 200default
GET
/api/v1/gdrive/get-access-token
Get Google Drive access token
getAccessToken → 200default
POST
/api/v1/gdrive/upload-gsheet
Upload to Google Sheet
uploadGsheet body → 200default

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are AdditionalMetric (23 properties), SlackSettings (15 properties), MetricQueryResponse (10 properties), CustomFormat (9 properties). Each schema is shown below with its type and property counts.

CustomFormat
object
9 properties 1 required
SortField
object
4 properties 2 required
WindowFunctionType
string
MetricType
string
ApiSuccess_SlackSettings-or-undefined_
object
2 properties 1 required
CustomBinDimension
CustomRangeBinDimension
object
7 properties 7 required
NumberSeparator
string
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
FrameType
string
TableCalculationBase
object
5 properties 2 required
FiltersResponse
object
3 properties
TableCalculationTemplate
FilterGroupResponse
UploadMetricGsheet
object
8 properties 5 required
FieldId
string
GroupValueRule
object
2 properties 2 required
CustomLabel
object
TableCalculationTemplateType.RANK_IN_COLUMN
string
FrameClause
object
3 properties 2 required
TemplateTableCalculation
ApiSlackCustomSettingsResponse
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.PERCENT_OF_COLUMN_TOTAL
string
TableCalculationTemplateType.WINDOW_FUNCTION
string
ApiSuccess_SlackChannel-Array-or-undefined_
object
2 properties 1 required
BinType.FIXED_WIDTH
string
ApiSlackChannelsResponse
FormulaTableCalculation
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…
BinRange
object
2 properties
ApiSuccessEmpty
object
2 properties 1 required
TableCalculation
TimeFrames
string
ApiSlackChannelResponse
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
SlackSettings
object
15 properties 5 required
FilterOperator
string
SqlTableCalculation
ApiSuccess_SlackChannel-or-null_
object
2 properties 2 required
ApiGdriveAccessTokenResponse
object
2 properties 2 required
FixedWidthBinDimension
object
7 properties 7 required
CustomDimensionType.BIN
string
CustomFormatType
string
FixedNumberBinDimension
object
7 properties 7 required
BinType.CUSTOM_RANGE
string
SlackChannelProjectMapping
object
3 properties 3 required
ApiSlackGetInstallationResponse
CompactOrAlias
MetricQueryResponse
object
10 properties 7 required
PivotConfig
object
8 properties 2 required
BinGroup
object
2 properties 2 required
GroupValueMatchType
string
AdditionalMetric
object
23 properties 4 required
Compact
string
BinType.FIXED_NUMBER
string
CustomSqlDimension
object
6 properties 6 required
TableCalculationTemplateType.RUNNING_TOTAL
string
FrameBoundary
object
2 properties 1 required
DimensionType
string
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
CustomDimension
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
CustomGroupBinDimension
object
7 properties 7 required
SlackAppCustomSettings
object
8 properties 2 required
ApiJobScheduledResponse
object
2 properties 2 required
CustomDimensionType.SQL
string
FrameBoundaryType
string
TableCalculationType
string
Format
string
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
BinType.CUSTOM_GROUP
string
SlackChannel
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-integrations-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
#Integration
← Back to L APIs
API Details
ID
lightdash:lightdash-integrations-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-integrations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightdash-integrations-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 Integrations 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.