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.

​
What it does

Returns the brand’s topical authority matrix — Citation Rate, Mention Rate, Average Rank, and Sentiment broken down per competitor — filterable by journey stage, persona, and AI model. Defaults to non-branded prompts only (the canonical scope for recommendation work). Branded comparisons are available on the Grow tier and require explicit opt-in via isBranded: true.

​
When to use

  • “Where am I weakest on purchase-stage prompts?”
  • “Who’s beating me on comparison queries for the founder persona?”
  • “How does my sentiment look across stages?”
  • “What’s my Citation Rate against [Competitor X]?”

​
When not to use

​
Inputs

FieldTypeDefaultMeaning
daysint (1–90)7Rolling window in days.
stagesJourneyStage[]all fourSubset of awareness_discovery / consideration_evaluation / purchase_intent / support_usage.
personaNamesstring[]allFilter to personas by display name.
modelCodesstring[]all configuredAI models, e.g. ["chatgpt", "perplexity"].
competitorNamesstring[]all trackedLimit comparison set.
isBrandedboolean | nullfalsefalse = non-branded only (default), true = branded only (Grow-tier gated), null = both.
Brand id is resolved from auth.

​
Response

{
  "citationRate": [
    { "isYou": true, "brand": "Citable", "value": 0.42 },
    { "isYou": false, "brand": "Profound", "value": 0.31 }
  ],
  "mentionRate": [
    { "isYou": true, "brand": "Citable", "value": 0.58 }
  ],
  "averageRank": [
    { "isYou": true, "brand": "Citable", "value": 2.3 }
  ],
  "sentiment": [
    { "isYou": true, "brand": "Citable", "value": { "score": 0.71, "sampleSize": 84, "confidence": "high" } }
  ],
  "tierGated": false,
  "scope": {
    "stages": ["awareness_discovery", "consideration_evaluation", "purchase_intent", "support_usage"],
    "isBranded": false,
    "competitorNames": ["Profound"],
    "modelCodes": ["chatgpt", "perplexity"],
    "personaNames": [],
    "days": 7,
    "appliedTier": "grow"
  }
}
Each metric array has one row per brand (yours + competitors) with isYou, brand name, and either a numeric value or a { score, sampleSize, confidence } object for sentiment.

​
Notes

  • isBranded default is false — non-branded prompts only — because non-branded is the recommendation-relevant scope. Passing true on a non-Grow brand returns the own-brand row with tierGated: true and no competitor rows.
  • Per-competitor averageRank and sentiment rows may be own-brand-only in some windows depending on sample size; citationRate and mentionRate always have full competitor breakdowns.