Retrieve Opportunity

Returns one computed opportunity and its execution context for the selected date window.

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/opportunities/{opportunity_id}:
    get:
      tags:
        - Opportunities
      summary: Retrieve Opportunity
      description: >-
        Returns one computed opportunity and its execution context for the
        selected date window.
      operationId: v2_opportunities_retrieve
      parameters:
        - name: opportunity_id
          in: path
          required: true
          schema:
            type: string
            title: Opportunity Id
        - name: since
          in: query
          required: false
          schema:
            type: string
            title: Since
          description: Relative or absolute window start.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            title: Start Date
          description: Inclusive start date; overrides `since`.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            title: End Date
          description: Inclusive end date; defaults to today.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2PromptOpportunity'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - LightsageApiKeyAuth: []
components:
  schemas:
    V2PromptOpportunity:
      properties:
        id:
          type: string
          title: Id
          description: >-
            Stable across requests and windows for the same finding and
            retrievable within a selected date window.
        type:
          type: string
          title: Type
          description: >-
            Determines which undeclared extra fields the object carries, such as
            `winner_brand_name` on `almost_winning`.
        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
        impact_score:
          type: number
          title: Impact Score
          description: >-
            Out of 100. Recomputed per window, so the same `id` can score
            differently across windows.
        created_at:
          type: string
          title: Created At
          description: Time of the request, since opportunities are computed per call.
      additionalProperties: true
      type: object
      required:
        - id
        - type
        - category
        - priority
        - title
        - description
        - action
        - execution_prompt
        - impact_score
        - created_at
      title: V2PromptOpportunity
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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.