API REFERENCE · SCHEMA

MonitoringPage schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas
itemsRequired
object[]
items item fields

Each array item: object.

items[].idRequired
string

Format: uuid.

items[].nameRequired
string
items[].statusRequired
string

Values: "active", "paused".

items[].requestRequired
object

Single subject input. Exactly one of sources or package is required. Only subject is unconditionally required; coverage and approved policy also have conditional requirements described below.

View ScreeningRequest schema
items[].request fields and rules

See all ScreeningRequest fields for the complete structure, required properties and constraints.

items[].counterpartyIdRequired
string or null

May be null.

items[].counterpartyId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

items[].lastScreeningIdRequired
string or null

May be null.

items[].lastScreeningId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

items[].nextRunAtRequired
string

Format: date-time.

items[].updatedAtRequired
string

Format: date-time.

items[].intervalHoursRequired
integer

Values: 6, 24, 168.

items[].revisionRequired
integer

Minimum: 0.

items[].lastErrorCodeRequired
string or null

Public code for the last failed check, or null. Use documented business codes for recovery; temporary service failures use temporarily_unavailable and other unclassified failures use screening_failed. A missing error code is not proof of a completed check: inspect health and lastSuccessfulAt.

May be null.

items[].lastErrorCode fields and rules

Allowed alternatives

  • string
  • null

    May be null.

items[].lastAttemptAtRequired
string or null

May be null.

items[].lastAttemptAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

items[].lastSuccessfulAtRequired
string or null

May be null.

items[].lastSuccessfulAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

items[].healthRequired
string

Values: "pending", "healthy", "overdue", "failed", "paused".

nextCursorRequired
string or null

May be null.

nextCursor fields and rules

Allowed alternatives

  • string
  • null

    May be null.

forecastRequired
MonitoringForecast or null

May be null.

forecast fields and rules

Allowed alternatives

  • MonitoringForecast
    forecast.generatedAtRequired
    string

    Format: date-time.

    forecast.periodEndRequired
    string

    Format: date-time.

    forecast.dailyScreeningsRequired
    number

    Minimum: 0.

    forecast.projectedRemainingScreeningsRequired
    integer

    Minimum: 0.

    forecast.effectiveLimitRequired
    integer

    Minimum: 0.

    forecast.usedRequired
    integer

    Minimum: 0.

    forecast.reservedRequired
    integer

    Minimum: 0.

    forecast.remainingRequired
    integer

    Minimum: 0.

    forecast.projectedExhaustionAtRequired
    string or null

    May be null.

    forecast.projectedExhaustionAt fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

  • null

    May be null.

forecastUnavailableRequired
string or null

May be null.

forecastUnavailable fields and rules

Allowed alternatives

  • string
  • null

    May be null.