website_id. Every other tool is a data tool and requires a website_id, which your client obtains from discovery first.
Each tool is labelled so clients know how to treat it:
Discovery
Nowebsite_id needed. Start here to find the site you want to work on.
read-only
The user your API key is bound to (id, email, name).
read-only
Flat list of the workspaces you belong to, with your role in each.
read-only
One-shot tree of your workspaces and the websites inside each, with
has_active_subscription and plan tier. The preferred way to pick a site.read-only
Paginated websites with subscription status.Args:
workspace_id (optional), page, page_sizeWebsite and subscription
read-only
Website metadata: url, name, aliases, topics, competitors, language, and subscription status.Args:
website_idread-only
Full plan detail: tier, status, trial and expiry, tracked AI platforms, feature availability, and every quota. Owner or admin only.Args:
website_idAudits
read-only
Audit quota used, limit, and remaining for the current period.Args:
website_idread-only
Every audit ever run for the website, most recent first, with scores, status, and page counts.Args:
website_idread-only
One audit: overall score, timing, and the list of audited pages.Args:
website_id, audit_idread-only
Page-level result with every criterion and its pass/fail status, plus the recommendations on each failing criterion. The most detailed audit view.Args:
website_id, audit_id, page_idwrite
Queue a new full-site audit. Runs asynchronously and counts against your quota.Args:
website_idwrite
Queue an audit of a single URL. The URL must be on the website’s domain.Args:
website_id, urlwrite
Queue an audit of a specific list of URLs, capped by your plan.Args:
website_id, urlswrite
Re-run an audit, reusing a prior audit’s page set and criteria.Args:
website_id, audit_idCitations
read-only
Paginated AI citations: the content the assistant produced, its sources, and which competitors were mentioned.Args:
website_id, page, page_size, time_range, website_citedread-only
One citation in full: the assistant’s answer, sources, brand mentions with sentiment, the triggering prompt, and competitor ranks.Args:
website_id, citation_idread-only
Top AI platforms by citation count.Args:
website_id, time_rangeShare-of-voice trend per platform over time.Args:
website_id, time_rangeread-only
Top source domains or URLs that appear in AI citations.Args:
website_id, time_range, group_by (domain or url), limitread-only
Uncapped, paginated list of every source URL by frequency.Args:
website_id, page, page_size, time_range, source_class (all, mentioned, background)read-only
Counts per match type (brand citation, site mention, background source) with a delta and a sparkline. Capped at 1 year.Args:
website_id, time_range, tzSentiment
Available on some plans. Both tools return403 if sentiment analysis is not on your plan, and cover up to 1 year.
read-only
Positive, negative, and neutral counts per brand (your site, competitors, unresolved).Args:
website_id, time_rangeread-only
Sentiment counts bucketed over time.Args:
website_id, time_range, bucket (day or week)Competitors
read-only
Competitor ranking (share of voice) against your website.Args:
website_id, time_rangeread-only
Citation counts per competitor.Args:
website_id, time_rangeread-only
Share-of-voice chart data for your site plus competitors.Args:
website_id, time_rangeTime series of your share of voice versus all competitors.Args:
website_id, time_rangeread-only
The maximum number of tracked competitors on your plan.Args:
website_idread-only
Competitors auto-discovered from your citations (available on some plans).Args:
website_idwrite
Add a tracked competitor. Enforces your competitor limit.Args:
website_id, name, url, aliaseswrite
Update a competitor’s name, URL, or aliases.Args:
website_id, competitor_id, name, url, aliaseswrite
Hide a suggested competitor.Args:
website_id, suggestion_idwrite
Promote a suggestion to a tracked competitor. Enforces your limit, and is available on some plans.Args:
website_id, suggestion_id, url, logo_url, aliasesdestructive
Remove a tracked competitor.Args:
website_id, competitor_idContent gap
Available on some plans. A limit of 0 means content gap is not on your plan.read-only
Monthly content-gap quota used, limit, and reset date.Args:
website_idread-only
Counts of gap suggestions by status and priority.Args:
website_idread-only
Paginated gap suggestions, sorted by similarity (the lowest is the biggest gap).Args:
website_id, status, min_score, max_score, limit, offsetread-only
Full gap detail: brief, outline, reasoning, the competitor topic, and your closest existing page.Args:
website_id, suggestion_idHealth
read-only
Global website health (AI crawlers allowed,
llms.txt present, sitemap reachable) plus improvement suggestions.Args: website_id, include_dismissedread-only
Monthly health-refresh quota used, limit, and reset date.Args:
website_idread-only
Monthly suggestion-regeneration quota.Args:
website_idread-only
Paginated indexed pages affected by a health suggestion.Args:
website_id, suggestion_id, page, per_pagewrite
Force a re-check of
robots.txt, llms.txt, and sitemap. Quota-limited.Args: website_idwrite
Hide a health suggestion.Args:
website_id, suggestion_idwrite
Un-hide a dismissed health suggestion.Args:
website_id, suggestion_idwrite
Regenerate suggestions from your indexed pages. Quota-limited.Args:
website_idIndexation and pages
read-only
Aggregated page stats: total, by category, pass rate, errors and warnings, and last crawl.Args:
website_idread-only
The latest indexation job status and progress counters.Args:
website_idread-only
Paginated indexed pages, filterable.Args:
website_id, category, health_passed, has_errors, has_warnings, language, search, limit, offsetread-only
One indexed page: URL, title, language, category, last crawl, health, and errors.Args:
website_id, page_idread-only
The most common health-check errors grouped by type with counts.Args:
website_id, limitwrite
Trigger a re-crawl of a single URL on the domain. Poll status afterward.Args:
website_id, urlPrompts
read-only
Prompts used versus your plan limit. Call this before bulk-creating prompts.Args:
website_idread-only
All prompts, grouped by topic, each with its visibility score.Args:
website_id, topic_idread-only
Paginated citations tied to a prompt.Args:
website_id, prompt_id, page, page_sizeread-only
Drill-down for a prompt: visibility with a 7-day delta, best rank and platform, coverage, a 30-day sparkline, a per-platform grid, and the latest answers.Args:
website_id, prompt_id, answers_limitread-only
Aggregated visibility stats across all of a prompt’s citations.Args:
website_id, prompt_idwrite
Create a prompt. Enforces your prompt quota.Args:
website_id, content, topic_id, localizationswrite
Update one prompt. Only the fields you provide change.Args:
website_id, prompt_id, content, topic_id, localizations, intent, journey_stagewrite
Apply the same metadata edit to many prompts at once (up to 1500).Args:
website_id, prompt_ids, topic_id, intent, journey_stagedestructive
Delete a prompt.Args:
website_id, prompt_idTopics
read-only
Every topic tracked for the website.Args:
website_idwrite
Create a topic for organizing prompts.Args:
website_id, namewrite
Rename a topic.Args:
website_id, topic_id, namedestructive
Delete a topic.Args:
website_id, topic_idSearch queries
read-only
The unique search-query variants AI assistants executed for your site.Args:
website_id, page, page_size, platformread-only
Query variants triggered by one prompt.Args:
website_id, prompt_id, page, page_sizeread-only
Query variants attached to one citation.Args:
website_id, citation_id, page, page_sizeSource intelligence
read-only
Aggregated source counts by
source_type and by AI platform. Call this first to know what exists.Args: website_idread-only
Suggested AI-cited sources for outreach, ordered by citation count.Args:
website_id, source_type, platform, search, limit, offsetVisibility is capped to your plan’s most-cited sources. Upgrading unlocks more sources, not different data.
Argument conventions
time_rangeaccepts:all_time,1y,1m,1w,1d. Sentiment and breakdown tools cap the range at 1 year.- Pagination comes in a few styles. Most tools use
pageandpage_size(1-based), content gaps and pages and suggested sources uselimitandoffset, and health suggestion pages usepageandper_page. - Enums you may pass:
- Prompt
intent:informational,comparative,transactional,navigational. - Prompt
journey_stage:discovery,consideration,decision,retention. - Search-query
platform:chatgpt,perplexity,gemini,claude,copilot. - Source
source_type:review_platform,media,blog,directory,forum,wiki,social. - Top-sources
group_by:domain,url. Sourcessource_class:all,mentioned,background. - Content-gap
status:pending,in_progress,completed,dismissed.
- Prompt
- Write and destructive tools change data in your workspace. Claude Desktop and Claude Code ask for confirmation before running them by default.