> ## 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.

# List Top Cited Urls

> Returns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources.



## OpenAPI

````yaml /openapi.json get /v2/visibility/citations
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: 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/citations:
    get:
      tags:
        - Visibility
      summary: List Top Cited Urls
      description: >-
        Returns URL-level citation counts ranked from most to least cited.
        Results can be filtered by platform and to owned or external sources.
      operationId: v2_visibility_citations_list
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            title: Start Date
          description: Inclusive range start.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
            title: End Date
          description: Inclusive range end; defaults to today.
        - name: platform
          in: query
          required: false
          schema:
            type: string
            title: Platform
          description: Optional answer-platform ID, name, or slug.
        - name: source_type
          in: query
          required: false
          schema:
            enum:
              - all
              - owned
              - external
            type: string
            default: all
            title: Source Type
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTopCitedUrlsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - LightsageApiKeyAuth: []
components:
  schemas:
    PublicTopCitedUrlsResponse:
      properties:
        date_range:
          $ref: '#/components/schemas/PublicCitedUrlDateRange'
        platform:
          anyOf:
            - type: string
            - type: 'null'
          title: Platform
          description: Platform selector applied to the results, or null for all platforms.
        source_type:
          type: string
          enum:
            - all
            - owned
            - external
          title: Source Type
          description: Whether the results include all, owned, or external URLs.
        has_data:
          type: boolean
          title: Has Data
          description: Whether any citations matched the selected filters.
        count:
          type: integer
          title: Count
          description: Number of URL rows returned.
        data:
          items:
            $ref: '#/components/schemas/PublicCitedUrl'
          type: array
          title: Data
          description: Cited URLs ranked by citation count in descending order.
      type: object
      required:
        - date_range
        - source_type
        - has_data
        - count
      title: PublicTopCitedUrlsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicCitedUrlDateRange:
      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.
        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: PublicCitedUrlDateRange
    PublicCitedUrl:
      properties:
        url:
          type: string
          title: Url
          description: Most frequently observed variant of the cited URL.
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
          description: Domain of the cited URL.
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: Page title, when available.
        favicon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Favicon Url
          description: Page favicon URL, when available.
        is_company_link:
          type: boolean
          title: Is Company Link
          description: Whether the URL belongs to an owned company domain.
        citation_count:
          type: integer
          title: Citation Count
          description: Number of citations to this normalized URL in the date range.
        prompt_count:
          type: integer
          title: Prompt Count
          description: Number of distinct active prompts that cited this URL.
        platform_names:
          items:
            type: string
          type: array
          title: Platform Names
          description: Platforms that cited this URL in the selected date range.
      type: object
      required:
        - url
        - is_company_link
        - citation_count
        - prompt_count
      title: PublicCitedUrl
    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
  securitySchemes:
    LightsageApiKeyAuth:
      type: apiKey
      in: header
      name: X-Lightsage-Api-Key

````

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