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

> List prompt opportunities with execution prompts.

Returns pre-computed opportunities from Lightsage's prompt visibility analysis.
Each opportunity includes an `execution_prompt` with the context an AI agent
needs to address it. This endpoint reads existing analysis; it does not run
prompts or generate new opportunities.



## OpenAPI

````yaml /openapi.json get /v1/opportunities
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/opportunities:
    get:
      tags:
        - Opportunities
      summary: List Opportunities
      description: >-
        List prompt opportunities with execution prompts.


        Returns pre-computed opportunities from Lightsage's prompt visibility
        analysis.

        Each opportunity includes an `execution_prompt` with the context an AI
        agent

        needs to address it. This endpoint reads existing analysis; it does not
        run

        prompts or generate new opportunities.
      operationId: opportunities_list
      parameters:
        - name: since
          in: query
          required: false
          schema:
            type: string
            description: >-
              Relative or absolute start date for opportunity analysis, such as
              30d, 72h, or 2026-06-01. Ignored when start_date is provided.
            title: Since
          description: >-
            Relative or absolute start date for opportunity analysis, such as
            30d, 72h, or 2026-06-01. Ignored when start_date is provided.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            description: Inclusive analysis start date (YYYY-MM-DD).
            title: Start Date
          description: Inclusive analysis start date (YYYY-MM-DD).
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            description: Inclusive analysis end date (YYYY-MM-DD). Defaults to today.
            title: End Date
          description: Inclusive analysis end date (YYYY-MM-DD). Defaults to today.
        - name: category
          in: query
          required: false
          schema:
            enum:
              - quick_wins
              - growth
              - refresh
              - citations
            type: string
            description: Filter opportunities to a high-level category.
            title: Category
          description: Filter opportunities to a high-level category.
        - name: opportunity_type
          in: query
          required: false
          schema:
            enum:
              - almost_winning
              - negative_sentiment
              - lost_wins
              - competitor_gaps
              - untapped_topics
              - platform_blind_spots
              - content_gaps
              - declining_visibility
              - volatile_visibility
              - citation_gaps
              - high_citation_sources
              - listicle_targets
            type: string
            description: Filter opportunities to a specific opportunity type.
            title: Opportunity Type
          description: Filter opportunities to a specific opportunity type.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: Maximum number of ranked opportunities to return.
            default: 50
            title: Limit
          description: Maximum number of ranked opportunities to return.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOpportunitiesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - LightsageApiKeyAuth: []
components:
  schemas:
    ListOpportunitiesResponse:
      properties:
        start_date:
          type: string
          title: Start Date
        end_date:
          type: string
          title: End Date
        data:
          items:
            $ref: '#/components/schemas/PublicPromptOpportunity'
          type: array
          title: Data
        count:
          type: integer
          title: Count
        summary:
          additionalProperties: true
          type: object
          title: Summary
      type: object
      required:
        - start_date
        - end_date
        - count
      title: ListOpportunitiesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicPromptOpportunity:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
        category:
          type: string
          title: Category
        priority:
          type: string
          title: Priority
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        action:
          type: string
          title: Action
        execution_prompt:
          type: string
          title: Execution Prompt
          description: >-
            Paste-ready instructions for an AI agent to address this
            opportunity.
        impact_score:
          type: number
          title: Impact Score
        created_at:
          type: string
          title: Created At
      additionalProperties: true
      type: object
      required:
        - id
        - type
        - category
        - priority
        - title
        - description
        - action
        - execution_prompt
        - impact_score
        - created_at
      title: PublicPromptOpportunity
    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
  securitySchemes:
    LightsageApiKeyAuth:
      type: apiKey
      in: header
      name: X-Lightsage-Api-Key

````