Retrieve Visibility Overview

Returns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only.

OpenAPI

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: []
tags:
  - name: Status
    description: Check API availability and validate the calling API key.
  - name: Visibility
    description: >-
      Measure visibility, citations, competitors, and prompt performance across
      answer platforms.
  - name: Prompts
    description: Manage tracked prompts and topics, and inspect their stored runs.
  - name: Opportunities
    description: Review ranked opportunities computed from prompt visibility results.
  - name: Tasks
    description: Manage the persisted action queue and task lifecycle.
  - name: Site Audits
    description: Review website audit results and page-level findings.
  - name: Agent Analytics
    description: >-
      See which coding agents, AI bots, and people visit your tracked sites,
      which pages they read, which pages return errors, and where the visits
      come from.
  - name: Evals
    description: Define eval tasks, judges, subjects, and saved configurations.
  - name: Eval Templates
    description: >-
      Select reusable judges, targets, schedules, metadata, and runtime settings
      with `POST /v2/eval-templates`, then copy only those settings into
      prompt-specific evals with `POST /v2/evals/batch`. Templates never contain
      prompts and remain independent from evals created from them.
  - name: Eval Runs
    description: Start eval runs and inspect their lifecycle state.
  - name: Eval Results
    description: Review completed eval outcomes and diagnostic details.
  - name: Agent Preference
    description: >-
      Compare your company head-to-head with a tracked competitor. Create a
      comparison with `POST /v2/agent-preference/evals`, run it with `POST
      /v2/eval-runs`, then read which company agents recommended.
  - name: Agents
    description: List runnable coding-agent harness and model combinations.
  - name: Repositories
    description: Manage reusable Git repository workspaces.
  - name: Environments
    description: List reusable runtime environments without exposing secret values.
  - name: MCP Servers
    description: List reusable MCP server integrations without exposing credentials.
  - name: CLIs
    description: List reusable command-line interfaces without exposing setup commands.
  - name: Skills
    description: List reusable skills available to workflows and evals.
paths:
  /v2/visibility/overview:
    get:
      tags:
        - Visibility
      summary: Retrieve Visibility Overview
      description: >-
        Returns aggregate snapshot, daily trends, per-platform breakdowns, and
        competitor comparison. Calculated from active prompts only.
      operationId: v2_visibility_overview_retrieve
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            title: Start Date
          description: >-
            Inclusive range start; defaults to 30 days before the end date. The
            range may span at most 90 days.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
            title: End Date
          description: Inclusive range end; defaults to today.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicVisibilityOverviewResponse'
        '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
        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: Includes 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
          description: >-
            The company relationship: `primary` for the organization's own
            company or `competitor` for a tracked competitor.
      type: object
      required:
        - name
      title: PublicCompany
    PublicVisibilityDateRange:
      properties:
        start_date:
          type: string
          title: Start Date
        end_date:
          type: string
          title: End Date
        granularity:
          type: string
          title: Granularity
          default: day
        latest_run_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Latest Run Date
        active_prompts_only:
          type: boolean
          title: Active Prompts Only
          default: true
      type: object
      required:
        - start_date
        - end_date
      title: PublicVisibilityDateRange
    PublicVisibilitySnapshot:
      properties:
        recommendation_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Recommendation Score
          description: >-
            Mean recommendation strength across successful prompt runs, from 0
            to 1. Each run contributes the company's recommendation strength (0
            to 1) when it is mentioned and 0 when it is not. Failed provider
            runs are excluded. `null` unless the organization turns on
            Recommendation Score under Settings › Navigation.
        recommendation_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Recommendation Score Rank
        visibility_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Score
          description: >-
            Fraction of successful prompt runs that mention the company, from 0
            to 1; for example, 0.25 means one in four runs. Failed provider runs
            are excluded.
        visibility_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Visibility Score Rank
        share_of_voice:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Of Voice
          description: >-
            The company's share of all mentions of tracked companies (your
            company plus configured competitors) in the same prompt runs, from 0
            to 1; tracked companies add up to 1. Each company counts once per
            run. `null` for companies you do not track. Not the `share_of_voice`
            field removed in October 2026, which held the mention rate now
            returned as `visibility_score`.
        share_of_voice_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Share Of Voice Rank
          description: Rank by `share_of_voice` among tracked companies, highest first.
        average_position:
          anyOf:
            - type: number
            - type: 'null'
          title: Average Position
          description: >-
            Mean mention position in AI responses; 1 is first and lower is
            better.
        average_position_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Average Position Rank
        total_citations:
          type: integer
          title: Total Citations
          description: >-
            Owned-domain citations across all platforms; 0, not `null`, with no
            prompt runs.
          default: 0
      type: object
      title: PublicVisibilitySnapshot
    PublicVisibilityTimeseries:
      properties:
        recommendation_score:
          items:
            $ref: '#/components/schemas/PublicSeriesPoint'
          type: array
          title: Recommendation Score
          description: >-
            Company recommendation score per day. Empty unless the organization
            turns on Recommendation Score under Settings › Navigation.
        visibility_score:
          items:
            $ref: '#/components/schemas/PublicSeriesPoint'
          type: array
          title: Visibility Score
          description: >-
            Company visibility score per day: the share of prompt runs that
            mention the company (0 to 1).
      type: object
      title: PublicVisibilityTimeseries
    PublicVisibilityByPlatform:
      properties:
        platforms:
          items:
            $ref: '#/components/schemas/PublicPlatformRef'
          type: array
          title: Platforms
        recommendation_score:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PublicSeriesPoint'
            type: array
          type: object
          title: Recommendation Score
          description: >-
            Recommendation score series keyed by `platform_id`. Empty unless the
            organization turns on Recommendation Score under Settings ›
            Navigation.
        visibility_score:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PublicSeriesPoint'
            type: array
          type: object
          title: Visibility Score
          description: >-
            Visibility score series keyed by `platform_id`: the share of that
            platform's prompt runs each day that mention the company (0 to 1).
        citations:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PublicSeriesPoint'
            type: array
          type: object
          title: Citations
          description: Owned-domain citation counts keyed by platform_id.
      type: object
      title: PublicVisibilityByPlatform
    PublicCompetitorRow:
      properties:
        company:
          $ref: '#/components/schemas/PublicCompany'
        recommendation_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Recommendation Score
          description: >-
            Mean recommendation strength across successful prompt runs, from 0
            to 1. Each run contributes the company's recommendation strength (0
            to 1) when it is mentioned and 0 when it is not. Failed provider
            runs are excluded. `null` unless the organization turns on
            Recommendation Score under Settings › Navigation. Rows do not sum to
            1.
        recommendation_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Recommendation Score Rank
        visibility_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Score
          description: >-
            Fraction of successful prompt runs that mention the company, from 0
            to 1; for example, 0.25 means one in four runs. Failed provider runs
            are excluded. A run can mention several companies, so rows do not
            sum to 1.
        visibility_score_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Visibility Score Rank
        share_of_voice:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Of Voice
          description: >-
            The company's share of all mentions of tracked companies (your
            company plus configured competitors) in the same prompt runs, from 0
            to 1; tracked companies add up to 1. Each company counts once per
            run. `null` for companies you do not track. Not the `share_of_voice`
            field removed in October 2026, which held the mention rate now
            returned as `visibility_score`.
        share_of_voice_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Share Of Voice Rank
          description: Rank by `share_of_voice` among tracked companies, highest first.
        average_position:
          anyOf:
            - type: number
            - type: 'null'
          title: Average Position
          description: >-
            Mean mention position in AI responses; 1 is first and lower is
            better. 0 when never mentioned.
        average_position_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Average Position Rank
          description: Companies with an `average_position` of 0 rank last.
      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
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicSeriesPoint:
      properties:
        date:
          type: string
          title: Date
          description: >-
            Only dates with prompt runs appear, so a series can be shorter than
            the range.
        value:
          anyOf:
            - type: number
            - type: 'null'
          title: Value
      type: object
      required:
        - date
      title: PublicSeriesPoint
    PublicPlatformRef:
      properties:
        platform_id:
          type: string
          title: Platform Id
        name:
          type: string
          title: Name
        icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Url
        mention_count:
          type: integer
          title: Mention Count
          description: >-
            Prompt runs where the company was mentioned on this platform in the
            date range.
          default: 0
        prompt_run_count:
          type: integer
          title: Prompt Run Count
          description: Total prompt runs on this platform in the date range.
          default: 0
      type: object
      required:
        - platform_id
        - name
      title: PublicPlatformRef
  securitySchemes:
    LightsageApiKeyAuth:
      type: apiKey
      in: header
      name: X-Lightsage-Api-Key

This documentation is built and hosted on Mintlify, a developer documentation platform.