List Agent Analytics Sources

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/agent-analytics/sites/{site_id}/sources:
    get:
      tags:
        - Agent Analytics
      summary: List Agent Analytics Sources
      description: >-
        Returns every coding agent and bot that visited a site in the date
        range, with its traffic type and visit count, most visits first. Human
        visits are one `people` row.
      operationId: v2_agent_analytics_sources_list
      parameters:
        - name: site_id
          in: path
          required: true
          schema:
            type: string
            title: Site Id
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            title: Start Date
          description: >-
            Inclusive range start; defaults to 6 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 in UTC; defaults to today.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAgentAnalyticsSourceListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - LightsageApiKeyAuth: []
components:
  schemas:
    PublicAgentAnalyticsSourceListResponse:
      properties:
        site_id:
          type: string
          title: Site Id
        start_date:
          type: string
          format: date
          title: Start Date
        end_date:
          type: string
          format: date
          title: End Date
        sources:
          items:
            $ref: '#/components/schemas/PublicAgentTrafficSource'
          type: array
          title: Sources
          description: Most visits first.
      type: object
      required:
        - site_id
        - start_date
        - end_date
      title: PublicAgentAnalyticsSourceListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicAgentTrafficSource:
      properties:
        name:
          type: string
          title: Name
          description: Agent or bot name, such as `claude-code` or `GPTBot`.
        kind:
          type: string
          enum:
            - agent
            - bot
            - other
            - people
          title: Kind
          description: >-
            `agent` for coding agents, `bot` for AI bots, `other` for bots with
            no AI purpose, and `people` for all human visits as one row.
        provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider
          description: Company that runs the bot.
        type:
          type: string
          enum:
            - coding
            - user
            - search
            - training
            - other
            - people
          title: Type
        visits:
          type: integer
          title: Visits
      type: object
      required:
        - name
        - kind
        - type
        - visits
      title: PublicAgentTrafficSource
    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