Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getcitable.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the brand’s AI visibility summary across ChatGPT, Gemini, Claude, Perplexity, and Grok. Includes brand visibility, citation share, sentiment score, top 5 competitors with visibility deltas, top 5 cited sources, and per-persona citation rates. Optionally filter personaCitationRates to a single persona.

When to use

  • “How visible am I across AI engines?”
  • “Am I winning the AI search war?”
  • “Which competitors are beating me?”
  • “How does persona X see my brand?”
Skip when the user wants the to-do list (use get_geo_priorities) or full brand identity (use get_brand_context).

Inputs

FieldTypeDefaultMeaning
windowDaysint7Rolling window for the summary.
personastringnoneFilter personaCitationRates to a single persona name (case-insensitive).

Response

{ windowDays, brandVisibility, citationShare, avgBrandRank, totalPrompts,
  completedPrompts, sentiment, topCompetitors[], topSources[],
  personaCitationRates[], lastAnalysisAt }

Example

Calling with { windowDays: 7, persona: "SMB founder" } narrows the persona section to matches of “SMB founder”.

See also