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

# Retrieve Visibility Overview

> Retrieve the visibility overview for the organization.

Mirrors the dashboard overview: a point-in-time `snapshot` (visibility score,
share of voice, average position, ranks, and total citations aggregated over
the range), a daily `timeseries` of visibility score, per-platform visibility
and citation series in `by_platform`, and a `competitors` comparison. Values
are calculated from currently active prompts. When the selected range has no
prompt-run data, snapshot values are `null` and `has_data` is `false`.



## OpenAPI

````yaml /openapi.json get /v1/visibility/overview
openapi: 3.1.0
info:
  title: Lightsage Public API
  description: Public API for Lightsage CLI and external integrations.
  version: 1.0.0
servers:
  - url: https://api.lightsage.com
    description: Production
security: []
paths:
  /v1/visibility/overview:
    get:
      tags:
        - Visibility
      summary: Retrieve Visibility Overview
      description: >-
        Retrieve the visibility overview for the organization.


        Mirrors the dashboard overview: a point-in-time `snapshot` (visibility
        score,

        share of voice, average position, ranks, and total citations aggregated
        over

        the range), a daily `timeseries` of visibility score, per-platform
        visibility

        and citation series in `by_platform`, and a `competitors` comparison.
        Values

        are calculated from currently active prompts. When the selected range
        has no

        prompt-run data, snapshot values are `null` and `has_data` is `false`.
      operationId: visibility_overview_retrieve
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            description: Optional start date. Defaults to 30 days before the end date.
            title: Start Date
          description: Optional start date. Defaults to 30 days before the end date.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
            description: Optional end date. Defaults to today.
            title: End Date
          description: Optional end date. Defaults to today.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicVisibilityOverviewResponse'
        '400':
          description: The requested date range is invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                required:
                  - detail
              examples:
                invalid_date_range:
                  summary: Invalid date range
                  value:
                    detail: start_date must be on or before end_date
        '404':
          description: No configured company was found for this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                required:
                  - detail
              examples:
                missing_company:
                  summary: Missing company
                  value:
                    detail: >-
                      Configured API Performance scope not found for this
                      organization
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - LightsageApiKeyAuth: []
components:
  schemas:
    PublicVisibilityOverviewResponse:
      properties:
        company:
          $ref: '#/components/schemas/PublicCompany'
        date_range:
          $ref: '#/components/schemas/PublicVisibilityDateRange'
        has_data:
          type: boolean
          title: Has Data
          description: Whether the selected date range contains visibility data.
        snapshot:
          $ref: '#/components/schemas/PublicVisibilitySnapshot'
        timeseries:
          $ref: '#/components/schemas/PublicVisibilityTimeseries'
        by_platform:
          $ref: '#/components/schemas/PublicVisibilityByPlatform'
        competitors:
          items:
            $ref: '#/components/schemas/PublicCompetitorRow'
          type: array
          title: Competitors
          description: Competitor comparison rankings, including the primary company.
      type: object
      required:
        - company
        - date_range
        - has_data
        - snapshot
        - timeseries
        - by_platform
      title: PublicVisibilityOverviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicCompany:
      properties:
        name:
          type: string
          title: Name
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
        relationship:
          anyOf:
            - type: string
            - type: 'null'
          title: Relationship
      type: object
      required:
        - name
      title: PublicCompany
    PublicVisibilityDateRange:
      properties:
        start_date:
          type: string
          title: Start Date
          description: Start date used for the calculation.
        end_date:
          type: string
          title: End Date
          description: End date used for the calculation.
        granularity:
          type: string
          title: Granularity
          description: Spacing between timeseries data points.
          default: day
        latest_run_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Latest Run Date
          description: Latest prompt-run date included in the calculation.
        active_prompts_only:
          type: boolean
          title: Active Prompts Only
          description: Whether only currently active prompts were included.
          default: true
      type: object
      required:
        - start_date
        - end_date
      title: PublicVisibilityDateRange
    PublicVisibilitySnapshot:
      properties:
        visibility_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Score
          description: Visibility score aggregated over the date range, from 0 to 1.
        visibility_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Visibility Score Rank
          description: Rank by visibility score among tracked companies.
        share_of_voice:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Of Voice
          description: Share of voice aggregated over the date range, from 0 to 1.
        share_of_voice_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Share Of Voice Rank
          description: Rank by share of voice among tracked companies.
        average_position:
          anyOf:
            - type: number
            - type: 'null'
          title: Average Position
          description: Average mention position aggregated over the date range.
        average_position_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Average Position Rank
          description: Rank by average mention position among tracked companies.
        total_citations:
          type: integer
          title: Total Citations
          description: Total owned-domain citations across all platforms in the range.
          default: 0
      type: object
      title: PublicVisibilitySnapshot
    PublicVisibilityTimeseries:
      properties:
        visibility_score:
          items:
            $ref: '#/components/schemas/PublicSeriesPoint'
          type: array
          title: Visibility Score
          description: Primary company visibility score over time.
      type: object
      title: PublicVisibilityTimeseries
    PublicVisibilityByPlatform:
      properties:
        platforms:
          items:
            $ref: '#/components/schemas/PublicPlatformRef'
          type: array
          title: Platforms
          description: Platforms present in the date range.
        visibility_score:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PublicSeriesPoint'
            type: array
          type: object
          title: Visibility Score
          description: Visibility score timeseries keyed by platform_id.
        citations:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PublicSeriesPoint'
            type: array
          type: object
          title: Citations
          description: Owned-domain citation-count timeseries keyed by platform_id.
      type: object
      title: PublicVisibilityByPlatform
    PublicCompetitorRow:
      properties:
        company:
          $ref: '#/components/schemas/PublicCompany'
        visibility_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Score
          description: Visibility score aggregated over the date range, from 0 to 1.
        visibility_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Visibility Score Rank
          description: Rank by visibility score among tracked companies.
        share_of_voice:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Of Voice
          description: Share of voice aggregated over the date range, from 0 to 1.
        share_of_voice_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Share Of Voice Rank
          description: Rank by share of voice among tracked companies.
        average_position:
          anyOf:
            - type: number
            - type: 'null'
          title: Average Position
          description: Average mention position aggregated over the date range.
        average_position_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Average Position Rank
          description: Rank by average mention position among tracked companies.
      type: object
      required:
        - company
      title: PublicCompetitorRow
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicSeriesPoint:
      properties:
        date:
          type: string
          title: Date
          description: Prompt-run date for this data point.
        value:
          anyOf:
            - type: number
            - type: 'null'
          title: Value
          description: Metric value on this date.
      type: object
      required:
        - date
      title: PublicSeriesPoint
    PublicPlatformRef:
      properties:
        platform_id:
          type: string
          title: Platform Id
          description: Stable platform identifier, e.g. chatgpt.
        name:
          type: string
          title: Name
          description: Human-readable platform name.
        icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Url
          description: Platform icon URL, if available.
      type: object
      required:
        - platform_id
        - name
      title: PublicPlatformRef
  securitySchemes:
    LightsageApiKeyAuth:
      type: apiKey
      in: header
      name: X-Lightsage-Api-Key

````