Everything Lumen collects is available over a read-only REST API, so you can pull your data into dashboards, warehouses, spreadsheets, or your own apps.
What you can pull
- Projects - brands, competitors, engines, and the latest scores.
- Scans - the full history with visibility, share of voice, sentiment, and rank, down to every raw AI answer.
- Prompts - the tracked prompt set with tags and campaigns.
- Web data - off-site mentions, plus website-health results: audits, duplicate content, readability.
- Boosters and actions - the recommendation backlog and board state.
- Time series - per-prompt appearance rates over time and proven-lift attributions.
Getting access
- Set an API key on your Lumen server with the LUMEN_API_KEY environment variable.
- Send it on every request as an Authorization: Bearer header (or x-api-key).
- Start at GET /api/v1 - the index lists every endpoint.
Reference
The full API reference documents every endpoint, parameter, and response shape, with copy-paste curl examples. The API is versioned under /api/v1 and read-only: it never modifies project data.