Skip to content

Document running evaluations from the API - #1814

Open
lightdash-bot wants to merge 2 commits into
mainfrom
cloudy/docs-2026-11-20-change-aabfd11fc4178a08
Open

lightdash-bot wants to merge 2 commits into
mainfrom
cloudy/docs-2026-11-20-change-aabfd11fc4178a08

Conversation

@lightdash-bot

@lightdash-bot lightdash-bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Collaborator

The evaluation docs never said a run can be started with the API, so readers saw no way to run evaluations on a schedule.

  • New Run evaluations from the API section with the run, list-runs and run-results endpoints
  • Shows a cron-driven curl call and links to Evaluation suites in agents-as-code for Git-managed suites

Review this PR individually. Close it to reject this change, then ask Cloudy to restack before merging.

Document running evaluations from the API

Pages

What changes

  • New Run evaluations from the API section with the run, list-runs and run-results endpoints
  • Shows a cron-driven curl call and links to Evaluation suites in agents-as-code for Git-managed suites

Why

The evaluation docs never said a run can be started with the API, so readers saw no way to run evaluations on a schedule.

Checked against

A teammate answered a support question that the docs should have covered. Started from this internal Slack thread (Lightdash workspace only).

@mintlify

mintlify Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
lightdash 🟢 Ready View Preview Nov 20, 2026, 10:16 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown
Contributor

I refreshed the sidebar navigation index in dd14418 to match the navigation, page titles, and API schema.

Next: someone with write access needs to select Approve workflows to run in the PR merge box. GitHub requires this approval because the update uses GITHUB_TOKEN. The follow-up CI run must pass on the corrected commit before merging.

View the index update run.

@github-actions

Copy link
Copy Markdown
Contributor

Documentation validation

✅ All blocking checks passed.

Component system

66 finding(s) across the corpus. Largest: prose.filler-word 22 · heading.question 22 · prose.anchor-index 12 · heading.overview 9 · prose.interface-narration 1.

Findings on lines this pull request touched are annotated inline in Files changed.

View the validation run.

This branch was successfully deployed

1 active deployment
staging — dd14418c Deployed Nov 20, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant