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

# List monitoring runs

> Inspect scheduled or change-driven monitoring evaluations, including per-integration freshness, coverage, failures and the resulting risk package.

Inspect scheduled or change-driven monitoring evaluations, including per-integration freshness, coverage, failures and the resulting risk package. All IDs and cursors must belong to the authorized workspace and environment. Required scope: signal:read.

Examples use synthetic IDs. Replace them with values returned by your environment.


## OpenAPI

````yaml openapi/amlok.json GET /v1/monitoring-runs
openapi: 3.1.0
info:
  title: AMLOK API
  version: 1.0.0
  description: >-
    AMLOK API: borrower connections, Insights origination, immutable risk
    packages and Signal monitoring. Use your institution-issued API origin.
servers: []
security:
  - BearerAuth: []
paths:
  /v1/monitoring-runs:
    get:
      tags:
        - Signal
      summary: List monitoring runs
      description: >-
        Inspect scheduled or change-driven monitoring evaluations, including
        per-integration freshness, coverage, failures and the resulting risk
        package. All IDs and cursors must belong to the authorized workspace and
        environment. Required scope: signal:read.
      operationId: listMonitoringRuns
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: limit
        - name: borrower_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: borrower id
        - name: monitor_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: monitor id
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MonitoringRun'
                  meta:
                    $ref: '#/components/schemas/Meta'
                  page:
                    $ref: '#/components/schemas/Page'
                required:
                  - data
                  - meta
                  - page
                additionalProperties: false
              example:
                data:
                  - id: mr_synthetic
                    monitor_id: mon_synthetic
                    status: partial
                    started_at: '2026-11-06T12:00:00Z'
                    completed_at: '2026-11-06T12:00:00Z'
                    risk_package_id: rp_signal_synthetic
                    sources:
                      - connection_id: con_synthetic
                        integration_id: bank_synthetic
                        source_as_of: '2026-11-01T00:00:00Z'
                        retrieved_at: '2026-11-06T12:00:00Z'
                        window:
                          start: '2025-11-01T00:00:00Z'
                          end: '2026-11-01T00:00:00Z'
                        status: partial
                        limitations:
                          - >-
                            Bank records alone do not establish a complete debt
                            schedule.
                    evidence_set_id: es_synthetic
                    limitations:
                      - Debt-service data remains incomplete.
                    record_version: 1
                    deal_snapshot_id: ds_synthetic
                    failure: null
                meta:
                  request_id: req_synthetic
                  schema_version: 1.0.0
                  environment: sandbox
                page:
                  next_cursor: null
                  has_more: false
                  snapshot_id: snap_synthetic
                  expires_at: '2026-11-06T13:00:00Z'
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '400':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: validation_error
                  message: Validation error.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '401':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: unauthenticated
                  message: Unauthenticated.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '403':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: forbidden
                  message: Forbidden.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '404':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: not_found
                  message: Not found.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '409':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: invalid_state
                  message: Invalid state.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '410':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: cursor_expired
                  message: Cursor expired.
                  retryable: false
                  request_id: req_synthetic
                  field: null
          headers:
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '429':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: rate_limited
                  message: Rate limited.
                  retryable: true
                  request_id: req_synthetic
                  field: null
          headers:
            Retry-After:
              description: Minimum delay in seconds before retry.
              schema:
                type: integer
                minimum: 0
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
        '503':
          description: >-
            Inspect structured error; retry only when retryable. 429 and 503 can
            include Retry-After.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                  - error
                additionalProperties: false
              example:
                error:
                  code: temporarily_unavailable
                  message: Temporarily unavailable.
                  retryable: true
                  request_id: req_synthetic
                  field: null
          headers:
            Retry-After:
              description: Minimum delay in seconds before retry.
              schema:
                type: integer
                minimum: 0
            X-Request-ID:
              schema:
                type: string
                minLength: 1
              description: Same request ID as meta.request_id or error.request_id.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request GET --fail-with-body --max-time 30 \
              "${AMLOK_API_BASE_URL}/v1/monitoring-runs" \
              --header "Authorization: Bearer ${AMLOK_API_KEY}" \
              --header 'Accept: application/json'
        - lang: Python
          source: >
            import os

            import requests


            headers = {'Accept': 'application/json'}

            headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

            response = requests.request('GET', os.environ["AMLOK_API_BASE_URL"]
            + '/v1/monitoring-runs', headers=headers, timeout=30,
            allow_redirects=False)

            response.raise_for_status()

            print(response.json())
        - lang: JavaScript
          source: >
            const headers = {"Accept": "application/json"};

            headers.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`;

            const response = await fetch(process.env.AMLOK_API_BASE_URL +
            "/v1/monitoring-runs", {
              method: "GET", headers, redirect: "error", signal: AbortSignal.timeout(30000)
            });

            if (!response.ok) throw new Error(`HTTP ${response.status}: ${await
            response.text()}`);

            console.log(await response.json());
components:
  schemas:
    MonitoringRun:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        monitor_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        status:
          type: string
          enum:
            - processing
            - completed
            - partial
            - failed
            - skipped
          description: >-
            Current lifecycle state. See the product lifecycle and recovery
            guides.
        started_at:
          type: string
          minLength: 1
          format: date-time
          description: >-
            Started at for MonitoringRun. Constraints, requiredness and allowed
            values are defined by this schema.
        completed_at:
          anyOf:
            - type: string
              minLength: 1
              format: date-time
            - type: 'null'
          description: >-
            Completed at for MonitoringRun. Constraints, requiredness and
            allowed values are defined by this schema.
        risk_package_id:
          anyOf:
            - type: string
              minLength: 1
              description: >-
                Opaque identifier, authorized within the API key workspace and
                environment.
            - type: 'null'
          description: >-
            Risk package id for MonitoringRun. Constraints, requiredness and
            allowed values are defined by this schema.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceCoverage'
          description: >-
            Sources for MonitoringRun. Constraints, requiredness and allowed
            values are defined by this schema.
        evidence_set_id:
          anyOf:
            - type: string
              minLength: 1
              description: >-
                Opaque identifier, authorized within the API key workspace and
                environment.
            - type: 'null'
          description: >-
            Evidence set id for MonitoringRun. Constraints, requiredness and
            allowed values are defined by this schema.
        limitations:
          type: array
          items:
            type: string
            minLength: 1
          description: >-
            Limitations for MonitoringRun. Constraints, requiredness and allowed
            values are defined by this schema.
        record_version:
          type: integer
          minimum: 1
          description: Monotonic version for this run; terminal evaluations are immutable.
        deal_snapshot_id:
          type: string
          minLength: 1
          description: Exact lender input snapshot frozen at evaluation start.
        failure:
          anyOf:
            - $ref: '#/components/schemas/Error'
            - type: 'null'
          description: >-
            Failure for MonitoringRun. Constraints, requiredness and allowed
            values are defined by this schema.
      required:
        - id
        - monitor_id
        - status
        - started_at
        - completed_at
        - risk_package_id
        - sources
        - evidence_set_id
        - limitations
        - record_version
        - deal_snapshot_id
        - failure
      additionalProperties: false
      description: >-
        One scheduled or change-driven evaluation, with per-integration coverage
        and frozen evidence. A skipped or stale sync is not a clean risk result.
      allOf:
        - if:
            properties:
              status:
                enum:
                  - failed
                  - skipped
          then:
            properties:
              failure:
                $ref: '#/components/schemas/Error'
              risk_package_id:
                type: 'null'
        - if:
            properties:
              status:
                enum:
                  - completed
                  - partial
          then:
            properties:
              risk_package_id:
                type: string
                minLength: 1
                description: Opaque identifier in the authorized workspace and environment.
              completed_at:
                type: string
                minLength: 1
                description: UTC timestamp in RFC 3339 format.
                format: date-time
              failure:
                type: 'null'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        schema_version:
          type: string
          minLength: 1
          description: >-
            Schema version for Meta. Constraints, requiredness and allowed
            values are defined by this schema.
        environment:
          type: string
          enum:
            - sandbox
            - live
          description: >-
            Environment for Meta. Constraints, requiredness and allowed values
            are defined by this schema.
      required:
        - request_id
        - schema_version
        - environment
      additionalProperties: false
    Page:
      type: object
      properties:
        next_cursor:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Next cursor for Page. Constraints, requiredness and allowed values
            are defined by this schema.
        has_more:
          type: boolean
          description: >-
            Has more for Page. Constraints, requiredness and allowed values are
            defined by this schema.
        snapshot_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        expires_at:
          type: string
          minLength: 1
          description: >-
            Snapshot expiry. After expiry, respond 410 and restart with a new
            snapshot; never continue on a new snapshot silently.
          format: date-time
      required:
        - next_cursor
        - has_more
        - snapshot_id
        - expires_at
      additionalProperties: false
      description: >-
        Opaque cursor binds filters, authorization and a stable snapshot.
        Expired cursors return 410; never silently restart.
    Error:
      type: object
      properties:
        code:
          type: string
          enum:
            - validation_error
            - unauthenticated
            - forbidden
            - not_found
            - invalid_state
            - idempotency_conflict
            - insufficient_credits
            - precondition_failed
            - cursor_expired
            - rate_limited
            - temporarily_unavailable
            - deal_snapshot_conflict
            - payload_too_large
            - unsupported_media_type
            - document_rejected
            - processing_failed
            - session_expired
            - consent_purpose_missing
            - sandbox_only
            - scenario_not_available
            - idempotency_result_expired
          description: >-
            Code for Error. Constraints, requiredness and allowed values are
            defined by this schema.
        message:
          type: string
          minLength: 1
          description: >-
            Message for Error. Constraints, requiredness and allowed values are
            defined by this schema.
        retryable:
          type: boolean
          description: >-
            Retryable for Error. Constraints, requiredness and allowed values
            are defined by this schema.
        request_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        field:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Field for Error. Constraints, requiredness and allowed values are
            defined by this schema.
      required:
        - code
        - message
        - retryable
        - request_id
        - field
      additionalProperties: false
    SourceCoverage:
      type: object
      properties:
        connection_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        integration_id:
          type: string
          minLength: 1
          description: >-
            Opaque identifier, authorized within the API key workspace and
            environment.
        source_as_of:
          anyOf:
            - type: string
              minLength: 1
              format: date-time
            - type: 'null'
          description: >-
            Source as of for SourceCoverage. Constraints, requiredness and
            allowed values are defined by this schema.
        retrieved_at:
          type: string
          minLength: 1
          format: date-time
          description: >-
            Retrieved at for SourceCoverage. Constraints, requiredness and
            allowed values are defined by this schema.
        window:
          anyOf:
            - $ref: '#/components/schemas/Window'
            - type: 'null'
          description: >-
            Window for SourceCoverage. Constraints, requiredness and allowed
            values are defined by this schema.
        status:
          type: string
          enum:
            - complete
            - partial
            - unavailable
            - stale
          description: >-
            Current lifecycle state. See the product lifecycle and recovery
            guides.
        limitations:
          type: array
          items:
            type: string
            minLength: 1
          description: >-
            Limitations for SourceCoverage. Constraints, requiredness and
            allowed values are defined by this schema.
      required:
        - connection_id
        - integration_id
        - source_as_of
        - retrieved_at
        - window
        - status
        - limitations
      additionalProperties: false
    Window:
      type: object
      properties:
        start:
          type: string
          minLength: 1
          format: date-time
          description: >-
            Start for Window. Constraints, requiredness and allowed values are
            defined by this schema.
        end:
          type: string
          minLength: 1
          format: date-time
          description: >-
            End for Window. Constraints, requiredness and allowed values are
            defined by this schema.
      required:
        - start
        - end
      additionalProperties: false
      description: UTC interval [start, end). The server rejects end <= start.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Server-to-server API key bound to exactly one workspace, institution
        tenant and environment. No caller-supplied workspace override is
        accepted. Do not use in public browser code.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.