Lumirank API docs

Changelog

Changes to the Lumirank API, newest first.

2026-10-10: v1

The 1st release of the Lumirank API.

  • GET /v1/brand: the brand that the key belongs to, and details of the key.
  • Prompts: GET /v1/prompts, GET /v1/prompts/{prompt_id}, POST /v1/prompts, PATCH /v1/prompts/{prompt_id}.
  • Competitors: GET /v1/competitors, GET /v1/competitors/{competitor_id}, PATCH /v1/competitors/{competitor_id}.
  • Answers: GET /v1/answers, GET /v1/answers/{answer_id}, GET /v1/mentions, GET /v1/citations.
  • Reports: GET /v1/reports/visibility, GET /v1/reports/brands, GET /v1/reports/citations.
  • include_archived on the 3 lists and the 3 reports: the answers of archived prompts are left out unless it is true.
  • A limit of 200 requests per minute for each brand.

Get the visibility report GET

Shows how often AI answers name your brand, how high they rank it, and how positive they are about it. The report has 1 row for each group. A group is the answers that have the same values for the dimensions you ask for, for example the same week and engine. An answer mentions your brand when the brand is in the answer's ranked list, or when its name is in the text. The numbers are the same as the numbers on the Overview page, in the sentiment spread, and on the Prompts page of the dashboard. Without dimensions, the report has 1 row for the whole date range. You can add up counts across rows, but not rates or averages. For a weekly number, ask for the `week` dimension instead of averaging 7 `day` rows.

On this page

2026-10-10: v1