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

# Simulate a monitor

> Test a monitor against recent historical data without activating it. The test runs in the background. Use the returned `simulation_id` to check its progress and results.



## OpenAPI

````yaml /api-rest/openapi/openapi_search_monitoring.json post /v1/search-monitoring/monitors/{monitor_id}/simulate
openapi: 3.1.0
info:
  title: Monitors API
  description: >-
    Coming soon. Run a saved Bigdata Search on a schedule and receive structured
    events from new content. Test a monitor against recent historical data
    before turning it on.
  version: 1.0.0
servers:
  - url: https://api.bigdata.com
    description: Production server
security:
  - API Key Authentication: []
tags:
  - name: Monitors
    description: Coming soon. Create, test, activate, and review monitors.
paths:
  /v1/search-monitoring/monitors/{monitor_id}/simulate:
    post:
      tags:
        - Monitors
      summary: Simulate a monitor
      description: >-
        Test a monitor against recent historical data without activating it. The
        test runs in the background. Use the returned `simulation_id` to check
        its progress and results.
      operationId: simulateMonitor
      parameters:
        - $ref: '#/components/parameters/MonitorId'
        - name: end_timestamp
          in: query
          required: true
          description: >-
            When the historical test should end, in UTC. This time must be at
            least five minutes in the past.
          schema:
            type: string
            format: date-time
          example: '2026-08-27T12:00:00Z'
        - name: number_of_runs
          in: query
          required: false
          description: >-
            Number of consecutive periods to test. The length of each period
            matches the monitor's frequency, and the periods count backward from
            `end_timestamp`.
          schema:
            type: integer
            default: 1
            minimum: 1
          example: 6
      responses:
        '202':
          description: Simulation accepted for asynchronous processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationResponse'
              examples:
                accepted:
                  value:
                    data:
                      monitor_id: 6af74cb7-0a6e-4ea0-8421-acde4c85e56a
                      simulation_id: sim_01J6C6J8VF7K8A4D7M2H5N9R3P
                      status: PENDING
                      retention_warning: Simulation results are retained for a limited time.
                    metadata:
                      request_id: req_01J6C6J96TVBKN6X3Z52JRDH8M
                      timestamp: '2026-08-28T08:12:15Z'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    MonitorId:
      name: monitor_id
      in: path
      required: true
      description: Unique identifier for the monitor.
      schema:
        type: string
        format: uuid
      example: 6af74cb7-0a6e-4ea0-8421-acde4c85e56a
  schemas:
    SimulationResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Simulation'
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
        - data
        - metadata
    Simulation:
      type: object
      properties:
        monitor_id:
          type: string
        simulation_id:
          type: string
        status:
          $ref: '#/components/schemas/RunStatus'
        retention_warning:
          type: string
          description: Information about how long simulation results remain available.
      required:
        - monitor_id
        - simulation_id
        - status
        - retention_warning
    Metadata:
      type: object
      properties:
        request_id:
          type: string
        timestamp:
          type: string
          format: date-time
      required:
        - request_id
        - timestamp
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    RunStatus:
      type: string
      enum:
        - PENDING
        - COMPLETED
        - FAILED
      description: >-
        `PENDING` is still processing, `COMPLETED` is ready to review, and
        `FAILED` could not be completed.
    ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
          additionalProperties: true
      required:
        - loc
        - msg
        - type
  responses:
    ValidationError:
      description: Validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
  securitySchemes:
    API Key Authentication:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key created in the Bigdata Developer Platform.

````