> ## Documentation Index
> Fetch the complete documentation index at: https://rankahead.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Analytics Tools — Rankahead MCP Reference

> Query visibility scores, citation data, answer gaps, and trend breakdowns for your tracked domains using the Rankahead analytics MCP tools.

The analytics tools give AI agents programmatic access to Rankahead's core visibility intelligence. Use them to fetch top-level KPIs, surface answer gaps your brand is missing, understand which domains are being cited by LLMs, and analyze how your visibility trends over time across providers and topics.

***

## get\_dashboard

Returns top-level KPIs for your account, including visibility score, mention rate, share of voice, per-LLM scores, competitor comparisons, and answer gap summaries. This is the best starting point for an overview of your AI visibility posture.

This tool takes no input parameters.

<CodeGroup>
  ```json Request theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_dashboard",
      "arguments": {}
    },
    "id": 1
  }
  ```
</CodeGroup>

<ResponseField name="visibilityScore" type="number">
  Overall visibility score from 0–100 across all tracked prompts and providers.
</ResponseField>

<ResponseField name="mentionRate" type="number">
  Percentage of prompt runs where your brand was mentioned in the LLM response.
</ResponseField>

<ResponseField name="shareOfVoice" type="number">
  Your brand's share of mentions relative to all tracked competitors.
</ResponseField>

<ResponseField name="perLlmScores" type="object">
  Visibility score broken down per LLM provider (OpenAI, Anthropic, Google, Perplexity).
</ResponseField>

<ResponseField name="competitors" type="object[]">
  List of tracked competitors with their respective visibility metrics.
</ResponseField>

<ResponseField name="answerGaps" type="object">
  Summary counts of critical and moderate answer gaps detected across your prompts.
</ResponseField>

***

## get\_gaps

Returns answer gap analysis for your domain — topics and questions where LLMs are not citing or mentioning your brand. Results are segmented into critical and moderate gaps and include heatmap data for prioritization.

<ParamField path="domainId" type="string">
  Optional domain ID to scope results to a specific tracked domain. Omit to return gaps across all domains.
</ParamField>

<CodeGroup>
  ```json Request — all domains theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_gaps",
      "arguments": {}
    },
    "id": 2
  }
  ```

  ```json Request — specific domain theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_gaps",
      "arguments": {
        "domainId": "dom_01j9z3k8p4c2x"
      }
    },
    "id": 3
  }
  ```
</CodeGroup>

<ResponseField name="critical" type="object[]">
  High-priority gaps where your brand is absent from LLM responses on commercially important prompts.
</ResponseField>

<ResponseField name="moderate" type="object[]">
  Lower-priority gaps with less immediate impact but worth addressing.
</ResponseField>

<ResponseField name="heatmap" type="object">
  Grid data mapping gap severity across topics and LLM providers for visualization.
</ResponseField>

***

## get\_citations

Returns citation analysis showing which external domains are cited across LLM responses and which providers cite them. Use this tool to understand your citation footprint and identify high-value third-party sources that influence AI answers in your category.

<ParamField path="promptId" type="string">
  Optional prompt ID to scope citation analysis to a single prompt. Omit to return citations across all prompts.
</ParamField>

<CodeGroup>
  ```json Request — all prompts theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_citations",
      "arguments": {}
    },
    "id": 4
  }
  ```

  ```json Request — specific prompt theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_citations",
      "arguments": {
        "promptId": "prm_02kxw9a1m7d3y"
      }
    },
    "id": 5
  }
  ```
</CodeGroup>

<ResponseField name="citations" type="object[]">
  List of cited domains, each with the number of times cited and which LLM providers cited them.
</ResponseField>

<ResponseField name="topSources" type="string[]">
  The most frequently cited domains, ranked by citation count across all providers.
</ResponseField>

***

## get\_trends

Returns visibility trends grouped by topic over a configurable time window. Results include per-provider breakdowns so you can see whether your gains or losses are concentrated in a specific LLM.

<ParamField path="days" type="number" default="30">
  Lookback window in days. Accepted values: `7`, `30`, `90`. Defaults to `30`.
</ParamField>

<ParamField path="provider" type="string">
  Filter results to a single LLM provider. Accepted values: `OPENAI`, `ANTHROPIC`, `GOOGLE`, `PERPLEXITY`. Omit to return all providers.
</ParamField>

<ParamField path="locale" type="string">
  Optional locale code (e.g. `en-US`) to filter trends by geographic market.
</ParamField>

<CodeGroup>
  ```json Request — 30-day all-provider trends theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_trends",
      "arguments": {
        "days": 30
      }
    },
    "id": 6
  }
  ```

  ```json Request — 7-day OpenAI trends theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_trends",
      "arguments": {
        "days": 7,
        "provider": "OPENAI",
        "locale": "en-US"
      }
    },
    "id": 7
  }
  ```
</CodeGroup>

<ResponseField name="topics" type="object[]">
  Trend data grouped by topic, each containing time-series visibility scores.
</ResponseField>

<ResponseField name="providerBreakdown" type="object">
  Per-provider visibility metrics for the selected time window.
</ResponseField>

***

## get\_prompt\_analytics

Returns detailed visibility analytics for a single prompt over time, including share of voice history and mention rate trends. Use this to evaluate the impact of content changes or new citations on a specific question your brand is targeting.

<ParamField path="promptId" type="string" required>
  The ID of the prompt to retrieve analytics for.
</ParamField>

<ParamField path="days" type="number" default="30">
  Lookback window in days. Defaults to `30`.
</ParamField>

<CodeGroup>
  ```json Request theme={null}
  {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "get_prompt_analytics",
      "arguments": {
        "promptId": "prm_02kxw9a1m7d3y",
        "days": 90
      }
    },
    "id": 8
  }
  ```
</CodeGroup>

<ResponseField name="visibilityTrend" type="object[]">
  Time-series visibility scores for this prompt over the selected window.
</ResponseField>

<ResponseField name="shareOfVoiceHistory" type="object[]">
  Historical share of voice data showing how your brand's presence changed relative to competitors.
</ResponseField>

<ResponseField name="mentionRateHistory" type="object[]">
  Day-by-day mention rate for this prompt across all LLM providers.
</ResponseField>
