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

# GenRank API: Access Your AI Visibility Data

> Pull brand mentions, visibility scores, sentiment, and competitor data directly from GenRank into your dashboards, apps, and workflows via the GenRank API.

The GenRank API gives you programmatic access to the same brand visibility data that powers the GenRank dashboard. Instead of reading your results in-app, you can pull mentions, rankings, sentiment attributes, and competitor co-occurrence directly into your own tools — internal dashboards, data warehouses, reporting pipelines, or client-facing portals.

The API is available on the **Scale plan** and is set up as a tailored integration. GenRank works with you to define the fields, output format, and delivery schedule that fit your stack before provisioning access.

<Note>
  API access requires the **Scale plan**. If you are on Free, Essential, or Pro, [contact GenRank](https://genrank.io/contact-us/) to discuss upgrading or request an API trial. Scale is custom-priced — book a demo to get a quote.
</Note>

## What the API provides

The GenRank API surfaces the data collected from running your tracked prompts in ChatGPT every day. Each response in the API reflects a single prompt execution and includes structured fields for brand configuration, mention detail, visibility scoring, perception attributes, and competitor co-occurrence.

<CardGroup cols={2}>
  <Card title="Citations" icon="link">
    Which domains ChatGPT cited in responses to your prompts, including your own domain's citation frequency.
  </Card>

  <Card title="Visibility" icon="eye">
    Visibility percent scores and mention rates across all tracked prompts, enabling trend analysis at scale.
  </Card>

  <Card title="Sentiment" icon="face-smile">
    Perceived brand qualities attributed to your brand in each response — the language ChatGPT uses to describe you.
  </Card>

  <Card title="Mentions" icon="at">
    Full mention objects including position, text excerpts, entity annotations, and the prompt that triggered the response.
  </Card>

  <Card title="Competitor visibility" icon="users">
    Which competitors appeared in the same response, enabling share-of-voice calculations and competitive benchmarking.
  </Card>

  <Card title="Brand configuration" icon="gear">
    Your brand name, domain, and geo targeting settings — the foundation for all tracked data.
  </Card>
</CardGroup>

## Who the API is for

The GenRank API is built for teams that want to integrate AI visibility data into existing infrastructure rather than relying solely on the GenRank dashboard. Typical use cases include:

* **Developers and data engineers** building internal visibility dashboards or feeding AI brand data into a data warehouse
* **Digital agencies** delivering white-labeled AI visibility reports to clients from their own platforms
* **Enterprise marketing teams** combining GenRank data with existing analytics stacks (GA4, Looker, Tableau, etc.)
* **Growth and product teams** triggering alerts or automations when brand visibility metrics shift

## How setup works

Because the GenRank API is tailored to each customer's needs, access is provisioned through a brief setup process rather than self-serve signup.

<Steps>
  <Step title="Contact GenRank">
    Reach out via [genrank.io/contact-us](https://genrank.io/contact-us/) or complete the API request form on the GenRank API page. Describe your use case, data frequency needs, and any custom fields or outputs you require.
  </Step>

  <Step title="Discuss your requirements">
    A GenRank team member will meet with you to understand your stack, agree on the fields and output structure you need, and confirm your prompt and geo configuration.
  </Step>

  <Step title="Receive your credentials">
    Once the integration is configured, GenRank provisions your API credentials and provides endpoint details specific to your account setup.
  </Step>

  <Step title="Start pulling data">
    Authenticate your requests and begin retrieving brand visibility data programmatically. GenRank remains available for ongoing support as your needs evolve.
  </Step>
</Steps>

## Sample API response

The following example shows the structure of a typical GenRank API response for a single tracked prompt. Field availability may vary based on your configured outputs.

```json theme={null}
{
  "brand": "GenRank",
  "domain": "genrank.io",
  "geo": "US",
  "query": "best chatgpt brand tracker",
  "mentions": [
    {
      "position": 1,
      "text_snippet": "GenRank is one of the top tools to track brand visibility in ChatGPT.",
      "annotations": [
        {
          "entity": "GenRank",
          "position_start": 0,
          "position_end": 7,
          "type": "brand"
        }
      ],
      "visibility_percent": 72.5,
      "perceived_brand_qualities": [
        "accurate",
        "easy to use",
        "SEO-focused"
      ],
      "competitors": ["SEranking", "ChatGPT Tracker"]
    }
  ],
  "last_checked": "2025-09-26T10:00:00Z"
}
```

## Explore the API reference

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    How API credentials work, how to authenticate requests, and how to keep your keys secure.
  </Card>

  <Card title="Brand data" icon="building" href="/api/brand-data">
    The brand configuration fields — name, domain, and geo targeting — that anchor every API response.
  </Card>

  <Card title="Mentions" icon="at" href="/api/mentions">
    Full reference for the mentions array, including position, text snippets, annotations, and visibility scores.
  </Card>

  <Card title="Competitors" icon="users" href="/api/competitors">
    How competitor data surfaces in API responses and how to use it for share-of-voice analysis.
  </Card>
</CardGroup>