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

# Get visibility overview

> Mention rate, citation rate and share of voice for the period, compared with the previous period, plus daily trends.
Requires `visibility:read`.




## OpenAPI

````yaml /openapi.yaml get /visibility/overview
openapi: 3.1.0
info:
  title: AeoNut API
  version: '1.0'
  description: >
    Read your workspace's AI visibility, content map and content data. Every
    response is wrapped in

    `{code, messages, data}`. Rates are fractions between 0 and 1 unless a field
    says otherwise.
servers:
  - url: https://services.deepsmith.ai/core/api/external/v1
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Me
  - name: Workspace
  - name: AI visibility
  - name: Content map
  - name: Content
  - name: IQ
paths:
  /visibility/overview:
    get:
      tags:
        - AI visibility
      summary: Get visibility overview
      description: >
        Mention rate, citation rate and share of voice for the period, compared
        with the previous period, plus daily trends.

        Requires `visibility:read`.
      parameters:
        - $ref: '#/components/parameters/Range'
      responses:
        '200':
          description: Overview
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          range:
                            $ref: '#/components/schemas/RangeValue'
                          mention_rate:
                            $ref: '#/components/schemas/RateBlock'
                          citation_rate:
                            $ref: '#/components/schemas/RateBlock'
                          share_of_voice:
                            description: '`null` when the workspace tracks no competitors.'
                            oneOf:
                              - $ref: '#/components/schemas/RateBlock'
                              - type: 'null'
                          trend_series:
                            type: object
                            properties:
                              mention:
                                $ref: '#/components/schemas/Trend'
                              citation:
                                $ref: '#/components/schemas/Trend'
              example:
                code: 2460
                data:
                  range: 30d
                  mention_rate:
                    current: 0.4231
                    previous: 0.3912
                    delta: 0.0319
                  citation_rate:
                    current: 0.1204
                    previous: 0.135
                    delta: -0.0146
                  share_of_voice:
                    current: 0.381
                    previous: 0.3502
                    delta: 0.0308
                  trend_series:
                    mention:
                      - date: '2026-09-01'
                        value: 0.4
                    citation:
                      - date: '2026-09-01'
                        value: 0.1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    Range:
      name: range
      in: query
      description: >-
        The period to report on. The previous period of the same length is
        returned for comparison.
      schema:
        $ref: '#/components/schemas/RangeValue'
  schemas:
    Envelope:
      type: object
      properties:
        code:
          type: integer
          description: AeoNut status code
        messages:
          type: string
        data: {}
    RangeValue:
      type: string
      enum:
        - 7d
        - 30d
        - 90d
      default: 30d
    RateBlock:
      type: object
      description: >-
        A rate for this period and the previous one, as fractions. A side is
        `null` when there is no data.
      properties:
        current:
          type:
            - number
            - 'null'
        previous:
          type:
            - number
            - 'null'
        delta:
          type:
            - number
            - 'null'
    Trend:
      type: array
      description: Daily values. Days without data are left out.
      items:
        type: object
        properties:
          date:
            type: string
            format: date
          value:
            type: number
    Scope:
      type: string
      enum:
        - workspace:read
        - visibility:read
        - contentmap:read
        - content:read
        - iq:read
  responses:
    Unauthorized:
      description: Missing (`code` 4021), invalid, revoked or expired (`code` 4022) API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            code: 4022
            messages: Invalid, revoked or expired API key.
            data: null
    Forbidden:
      description: The key lacks a required scope
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Envelope'
              - properties:
                  data:
                    type: object
                    properties:
                      required:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
                      missing:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
          example:
            code: 4023
            messages: This API key does not have the scope required for this request.
            data:
              required:
                - visibility:read
              missing:
                - visibility:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer API Key Value`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

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