Start free trial
Docs sections

API and MCP

API and MCP

Read your Botlum data from scripts and reports, or ask your AI assistant about it directly.

Two ways in

  • MCP lets an AI assistant (Claude, ChatGPT, Codex, Cursor and others) ask Botlum directly: "how visible were we in ChatGPT in Germany last month, and who replaced us?" The server is at https://dash.botlum.com/mcp.
  • The REST API gives you the same numbers as JSON or CSV for your own reports, spreadsheets and scripts. It lives under https://dash.botlum.com/api/v1.

Both are read-only and come with every plan, the trial included.

Signing in

CredentialWorks withBest for
Sign in with your Botlum account (OAuth) MCP claude.ai, ChatGPT, Codex, Claude Code: add the URL, sign in, pick the workspace. See Connect an AI assistant.
API key MCP and the REST API Scripts, Cursor, and anything that sends an Authorization header. See API keys.

Either way, access is to one workspace, read-only, as a viewer.

What you can read

  • projects with their names, domains and competitors;
  • prompts and topics;
  • visibility: overview, by day, by prompt, country or topic, brands side by side, discovered brands;
  • single answers with their text, sources and the searches the engine ran;
  • cited domains and pages, the source gap, and the answers that cite a domain;
  • CSV exports.

The numbers are the dashboard's own: the API answers through the same code, so they always agree. Ratios are between 0 and 1, and are null when nothing was measured: unknown is not zero.

Limits

60 requests a minute per key or per person. Over that, the API answers 429 Too Many Requests with a Retry-After header in seconds. Date ranges cover at most 92 days.

Stability

Version 1 only adds things: new fields and new endpoints, never a removed or renamed field. Write clients that ignore fields they do not know. A breaking change would come as /api/v2, with v1 kept running.

Where to start