Skip to main content
The public API lets you read GEO analytics and run approved project workflows, including prompt creation, competitor review, action execution, recorded URL management, reports, and integration checks.
AI agents (Claude Code, Cursor, OpenClaw): Use account information explicitly supplied or authorized by the user. API keys can only be created by team admins and currently grant access to the full team. See Agentic setup.

​
Base URL

All endpoint paths in this reference are relative to this base URL.

​
Authentication

Every request requires an API key in the X-API-Key header. See authentication for details.
Use API keys only from trusted server-side code. Current keys grant access to every project owned by the team, so never expose them in a browser, client application, log, prompt, or chat history.

​
Response envelope

Most customer API endpoints use this envelope: Success:
Error:
Some setup and write operations, including /account/*, prompt writes and generation, and recorded URLs, use {"code": 200, "message": "200 OK", "data": {...}}. The report endpoint returns HTML. Check each endpoint’s response example before parsing it.

​
HTTP status codes

​
Date range filtering

Most analytics endpoints accept these query parameters: If both duration_days and date_from/date_to are provided, the explicit date range takes precedence. Maximum range is 90 days.

​
Provider filtering

Analytics endpoints accept a providers query parameter:
Supported values: chatgpt, perplexity, google_ai_overview, gemini, claude. Omitting returns data from all providers.

​
Pagination

Endpoints with large result sets support page-based pagination:

​
Rate limit headers

Every response includes these headers:

​
Agentic setup

Agentic setup

Set up an account and project after the user explicitly authorizes the identity, team, and project details.

​
Endpoints

Projects

List and retrieve tracked projects.

Brand aliases

Manage alternative names used for brand recognition.

Recorded URLs

Manage URL inputs used for prompt discovery.

Prompts

Prompts, analytics, AI responses, domains, and URLs.

Competitors

Competitor brands with aggregated metrics.

Sources

Source domains cited in AI responses.

Topics

Topic groups that organize prompts.

Overview

Per-prompt aggregated analysis.

Visibility trends

Time-series competitor metrics over time.

Sources analytics

Category breakdown, performance trends, and opportunities.

Reports

Generate self-contained HTML visibility reports.

Actions

Review recommendations, execute workflows, and fetch artifacts.

Agent settings

Test publishing integration credentials.

Webhooks

Receive action and project lifecycle events.