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

# Overview

> The full dashboard payload: brand leaderboard, trends, sentiment, platform rollups, and competitor comparison.

The full dashboard payload: brand leaderboard, brand-visibility and share-of-voice trends, sentiment split, per-platform rollups, and the you-vs-average-competitor comparison. Cap the leaderboard with `topBrands`.

Time series are columnar - a shared `dates` array plus one numeric array per series - rather than one object per day.

The sentiment split comes as `sentiment.shares` and `sentiment.changes`, and the comparison rows as `performanceRows` keyed by metric. `chartSeed` holds your brand's chart color, the competitor list that orders series colors, and the series keys your brand uses on each chart.

Scope filters are described on [AI Visibility](https://snowseo.com/docs/api-reference/endpoints/ai-visibility.md).


## OpenAPI

````yaml GET /v3/ai-tracker/visibility/overview
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security:
  - bearerAuth: []
  - apiKey: []
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/ai-tracker/visibility/overview:
    get:
      tags:
        - AI Tracker
      summary: AI visibility overview (leaderboard, trends, comparison)
      description: >-
        Full AI-visibility overview: brand leaderboard, brand-visibility and
        share-of-voice trends, sentiment split, per-platform mention/citation
        rollups and a you-vs-average-competitor comparison. Large payload that
        grows with window length x tracked brands - keep the window to 30-90
        days and leave topBrands at its default unless a wider leaderboard is
        genuinely needed. For headline numbers only, use ai_visibility_summary;
        for just the trend lines, use ai_visibility_trends.
      operationId: getAiVisibilityOverview
      parameters:
        - schema:
            type: string
          in: query
          name: teamId
          required: false
        - schema:
            type: string
          in: query
          name: platform
          required: false
          description: Comma-separated AI platform names, or 'All Platforms' for no filter.
        - schema:
            type: string
          in: query
          name: competitor
          required: false
          description: >-
            Comma-separated competitor names, or 'All Competitors' for no
            filter. Keeps prompts where ANY listed competitor appears.
        - schema:
            type: string
          in: query
          name: country
          required: false
          description: >-
            Comma-separated ISO2 country codes, or 'All Countries' for no
            filter.
        - schema:
            type: string
          in: query
          name: startDate
          required: false
          description: >-
            YYYY-MM-DD. Omit with endDate set for All Time (from the first
            answer, no previous-period comparison).
        - schema:
            type: string
          in: query
          name: endDate
          required: false
          description: YYYY-MM-DD
        - schema:
            type: integer
            minimum: 1
            default: 30
          in: query
          name: days
          required: false
          description: >-
            Days back from today on the team's calendar, converted to
            startDate/endDate. Ignored when startDate or endDate is set.
            Defaults to 30.
        - schema:
            type: string
          in: query
          name: promptBrand
          required: false
          description: '''branded'', ''unbranded'', or ''all''.'
        - schema:
            type: string
          in: query
          name: tracking
          required: false
          description: '''tracked'', ''untracked'', or empty for both.'
        - schema:
            type: string
          in: query
          name: intent
          required: false
          description: Comma-separated prompt intents, or empty for all.
        - schema:
            type: string
          in: query
          name: includePrevious
          required: false
          description: >-
            Include previous-period comparison values alongside each data point
            (roughly doubles the time-series payload). Defaults to false.
        - schema:
            type: string
          in: query
          name: topBrands
          required: false
          description: >-
            Max leaderboard rows, or 'all'. Defaults to 25. Rows are ordered by
            mentions descending; the response reports topBrandsTotal and
            topBrandsTruncated.
        - schema:
            type: string
          in: query
          name: seriesLimit
          required: false
          description: >-
            Max brands to plot on the trend charts, or 'all'. Defaults to
            whatever topBrands is, which is what you want unless you need the
            full leaderboard alongside only a few chart lines.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  meta:
                    type: object
                    additionalProperties: true
                    properties:
                      teamInfo:
                        type: object
                        additionalProperties: true
                      appliedFilters:
                        type: object
                        additionalProperties: true
                      totalPrompts:
                        type: number
                      activePrompts:
                        type: number
                      activeRegionRuns:
                        type: number
                      totalResponses:
                        type: number
                      promptStatus:
                        type: object
                        additionalProperties: true
                  overview:
                    type: object
                    additionalProperties: true
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  reference:
                    type: string
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  reference:
                    type: string
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  reference:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your SnowSEO API key (sk_...).
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.