> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbitsearch.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List watcher runs

> Per-run history: outcome, new-event count, the sources behind the changes, and what was billed.

Runs are listed newest first. Each run returns the events it added (`events`: dated timeline entries with `date`, `datePrecision`, `dateBasis` and their `sources`, identical to `sections.eventsTimeline` on [profile reads](/api/enrich/read-profile#profile-sections)), the source-level deltas behind them (`changes`), and what it cost. You pay for completed runs.


## OpenAPI

````yaml openapi.json GET /v3/watchers/{watcher_id}/runs
openapi: 3.1.0
info:
  title: Orbit API
  version: 3.0.0
  description: Search for people and enrich known Orbit profiles.
servers:
  - url: https://api.orbitsearch.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Find people and poll search results.
  - name: Enrich
    description: Read or enrich known Orbit profiles.
  - name: Watchers
    description: Watch a profile on a schedule and read what each run found.
  - name: Webhooks
    description: Register endpoints that receive signed event deliveries.
paths:
  /v3/watchers/{watcher_id}/runs:
    get:
      tags:
        - Watchers
      summary: List watcher runs
      description: >-
        The watcher's refresh runs, newest first: outcome, the events each run
        added with their sources, and what was billed. Requires the
        `watchers:write` scope.
      operationId: listWatcherRuns
      parameters:
        - $ref: '#/components/parameters/WatcherId'
        - name: limit
          in: query
          required: false
          description: Maximum runs to return.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 200
      responses:
        '200':
          description: The runs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatcherRunList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    WatcherId:
      name: watcher_id
      in: path
      required: true
      description: The watcher ID returned at creation.
      schema:
        type: string
        format: uuid
  schemas:
    WatcherRunList:
      type: object
      required:
        - runs
      properties:
        runs:
          type: array
          items:
            $ref: '#/components/schemas/WatcherRun'
          description: Newest first.
    WatcherRun:
      type: object
      required:
        - run_id
        - status
        - new_event_count
        - charge_amount
        - charged
        - changes
        - dispatched_at
      properties:
        run_id:
          type: string
        status:
          type: string
          enum:
            - dispatched
            - completed
            - failed
          description: '`dispatched` while running, then `completed` or `failed`.'
        runs_covered:
          type: integer
          description: >-
            Completed refresh runs folded into this entry; `run_id` names the
            newest.
        new_event_count:
          type:
            - integer
            - 'null'
          description: >-
            The length of `events`. Null while the timeline is temporarily
            unavailable; retry, or read the profile.
        duration_seconds:
          type:
            - number
            - 'null'
        charge_amount:
          type: number
          description: Credits charged for the run.
        charged:
          type: boolean
        changes:
          type: array
          items:
            $ref: '#/components/schemas/WatcherRunChange'
          description: >-
            The source-level deltas behind the run's events. The same kinds as
            `profile.updated` deliveries and the events timeline.
        events:
          type:
            - array
            - 'null'
          items:
            type: object
            description: >-
              A timeline event in the exact shape profile reads return in
              `sections.eventsTimeline`: `title`, `description`, `date`,
              `datePrecision`, `dateBasis`, `eventKey`, `updateCount`,
              `lastUpdatedAt`, `sources`, `changes`.
          description: >-
            The timeline events this run produced. Every event carries its
            `date`, `datePrecision`, `dateBasis` and `sources`; a profile read
            returns identical objects. Null while the timeline is temporarily
            unavailable; the run data itself is durable.
        error:
          type:
            - string
            - 'null'
        dispatched_at:
          type: string
          format: date-time
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      required:
        - status
        - error
      properties:
        status:
          type: string
          enum:
            - failed
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
    WatcherRunChange:
      type: object
      required:
        - change_kind
      properties:
        change_kind:
          type: string
          enum:
            - new_source
            - source_update
            - social_post
          description: >-
            `new_source` is a newly discovered page about the person,
            `source_update` an update to a page already on the profile,
            `social_post` new social activity.
        link:
          type: string
          format: uri
        platform:
          type: string
          description: Social network for `social_post` changes.
        new_posts:
          type: integer
          description: Posts found, for `social_post` changes.
        title:
          type: string
        summary:
          type: string
          description: What changed, in one sentence.
  responses:
    BadRequest:
      description: The request is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: The API key does not have the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: The API key exceeded a rate limit.
      headers:
        Retry-After:
          description: Seconds to wait before another request.
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Orbit API key
      description: Use an Orbit API key from the developer dashboard.

````