Lightdash

Lightdash Homepage API

The Homepage API from Lightdash — 17 operation(s) for homepage.

GitHub OpenAPI

Operations 23

GET /api/v1/projects/{projectUuid}/homepage Get resolved project homepage #
POST /api/v1/projects/{projectUuid}/homepage Create project homepage #
GET /api/v1/projects/{projectUuid}/homepage/view-as View homepage as #
GET /api/v1/projects/{projectUuid}/homepage/builder Get project homepage for builder #
GET /api/v1/projects/{projectUuid}/homepage/link-metadata Get homepage link metadata #
GET /api/v1/projects/{projectUuid}/homepage/recently-viewed Get homepage recently viewed #
GET /api/v1/projects/{projectUuid}/homepage/assignments Get homepage assignments #
PATCH /api/v1/projects/{projectUuid}/homepage/group-priorities Update homepage group priorities #
GET /api/v1/projects/{projectUuid}/homepage/list List project homepages #
PATCH /api/v1/projects/{projectUuid}/homepage/{homepageUuid} Update project homepage draft #
DELETE /api/v1/projects/{projectUuid}/homepage/{homepageUuid} Delete project homepage #
POST /api/v1/projects/{projectUuid}/homepage/{homepageUuid}/discard-draft Discard project homepage draft #
POST /api/v1/projects/{projectUuid}/homepage/{homepageUuid}/publish Publish project homepage #
GET /api/v1/projects/{projectUuid}/announcements List project announcements #
POST /api/v1/projects/{projectUuid}/announcements Create project announcement #
PATCH /api/v1/projects/{projectUuid}/announcements/{announcementUuid} Update project announcement #
DELETE /api/v1/projects/{projectUuid}/announcements/{announcementUuid} Delete project announcement #
POST /api/v1/projects/{projectUuid}/announcements/images Upload project announcement image #
GET /api/v1/org/homepage-settings Get organization homepage settings #
PATCH /api/v1/org/homepage-settings Update organization homepage settings #
GET /api/v1/ee/homepage/recommended-action-skips List homepage recommended action skips #
POST /api/v1/ee/homepage/recommended-action-skips Skip homepage recommended action #
DELETE /api/v1/ee/homepage/recommended-action-skips/{actionKey} Unskip homepage recommended action #

Documentation

📖
Documentation
https://docs.lightdash.com/api-reference/v1/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-homepage-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-project.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-dashboard.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-chartsummary.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-space.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-scimuser.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-serviceaccount.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-schedulerandtargets.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-apierrorpayload.json

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/vocabulary/lightdash-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-ld/lightdash-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightdash:lightdash-homepage-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightdash-homepage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightdash Homepage API
  version: 2.616.2
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens'
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-homepage-api-openapi.yml