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

# Get the site overview

> Returns the main visibility metrics of the site: visibility, share of voice, rank, sentiment and authority, with a trend and the result of each AI assistant. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to select the comparison period (`previous`, `previous_year` or `custom` with `compare_since` and `compare_until`). Use `persona` and `llm` to limit the data to one persona and to some AI assistants.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/sites/{site_uuid}/overview
openapi: 3.0.3
info:
  title: Perquery API
  version: 1.0.0
  description: Read-only access to the data of your Perquery organization.
servers:
  - url: https://perquery.ai/api
security:
  - apiKey: []
paths:
  /v1/sites/{site_uuid}/overview:
    get:
      tags:
        - Visibility
      summary: Get the site overview
      description: >-
        Returns the main visibility metrics of the site: visibility, share of
        voice, rank, sentiment and authority, with a trend and the result of
        each AI assistant. Use `date_range` to select the period (`7g`, `1a`,
        `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to
        select the comparison period (`previous`, `previous_year` or `custom`
        with `compare_since` and `compare_until`). Use `persona` and `llm` to
        limit the data to one persona and to some AI assistants.
      operationId: site_overview
      parameters:
        - in: query
          name: compare
          schema:
            enum:
              - previous
              - previous_year
              - custom
            type: string
            default: previous
            minLength: 1
          description: |-
            * `previous` - previous
            * `previous_year` - previous_year
            * `custom` - custom
        - in: query
          name: compare_since
          schema:
            type: string
            format: date
          description: The first day of a `custom` comparison.
        - in: query
          name: compare_until
          schema:
            type: string
            format: date
          description: The last day of a `custom` comparison.
        - in: query
          name: date_range
          schema:
            enum:
              - 7g
              - 1a
              - 3a
              - 6a
              - 1y
              - custom
            type: string
            default: 1a
            minLength: 1
          description: |-
            * `7g` - 7g
            * `1a` - 1a
            * `3a` - 3a
            * `6a` - 6a
            * `1y` - 1y
            * `custom` - custom
        - in: query
          name: llm
          schema:
            type: array
            items:
              enum:
                - chatgpt
                - gemini
                - claude
                - perplexity
                - googleai
                - grok
                - deepseek
              type: string
              description: |-
                * `chatgpt` - chatgpt
                * `gemini` - gemini
                * `claude` - claude
                * `perplexity` - perplexity
                * `googleai` - googleai
                * `grok` - grok
                * `deepseek` - deepseek
        - in: query
          name: persona
          schema:
            type: string
            format: uuid
            nullable: true
        - in: query
          name: since
          schema:
            type: string
            format: date
          description: The first day of a `custom` range.
        - in: path
          name: site_uuid
          schema:
            type: string
            format: uuid
          required: true
        - in: query
          name: until
          schema:
            type: string
            format: date
          description: The last day of a `custom` range.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteOverviewResponse'
          description: ''
      security:
        - apiKey: []
components:
  schemas:
    SiteOverviewResponse:
      type: object
      properties:
        has_measurements:
          type: boolean
        measured_prompts:
          type: integer
        visibility:
          $ref: '#/components/schemas/ScorecardDTO'
        share_of_voice:
          $ref: '#/components/schemas/ScorecardDTO'
        rank:
          $ref: '#/components/schemas/ScorecardDTO'
        sentiment:
          $ref: '#/components/schemas/ScorecardDTO'
        authority:
          $ref: '#/components/schemas/ScorecardDTO'
        trend:
          type: array
          items:
            $ref: '#/components/schemas/OverviewTrendPointDTO'
        engines:
          type: array
          items:
            $ref: '#/components/schemas/EngineVisibilityDTO'
      required:
        - authority
        - engines
        - has_measurements
        - measured_prompts
        - rank
        - sentiment
        - share_of_voice
        - trend
        - visibility
    ScorecardDTO:
      type: object
      properties:
        value:
          type: number
          format: double
          nullable: true
        delta:
          type: number
          format: double
          nullable: true
    OverviewTrendPointDTO:
      type: object
      properties:
        captured_at:
          type: string
          format: date-time
        visibility:
          type: number
          format: double
          nullable: true
        share_of_voice:
          type: number
          format: double
          nullable: true
        rank:
          type: number
          format: double
          nullable: true
        sentiment:
          type: number
          format: double
          nullable: true
        authority:
          type: number
          format: double
          nullable: true
      required:
        - captured_at
    EngineVisibilityDTO:
      type: object
      properties:
        assistant:
          $ref: '#/components/schemas/Assistant'
        visibility:
          type: number
          format: double
      required:
        - assistant
        - visibility
    Assistant:
      enum:
        - chatgpt
        - gemini
        - claude
        - perplexity
        - googleai
        - grok
        - deepseek
      type: string
      description: |-
        * `chatgpt` - chatgpt
        * `gemini` - gemini
        * `claude` - claude
        * `perplexity` - perplexity
        * `googleai` - googleai
        * `grok` - grok
        * `deepseek` - deepseek
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: '`ApiKey pq_<prefix>_<secret>`. An API key gives read-only access.'

````

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