API REFERENCE · SCHEMA
Monitoring
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.
generatedAtRequired- string
Format: date-time.
periodEndRequired- string
Format: date-time.
dailyScreeningsRequired- number
Minimum: 0.
projectedRemainingScreeningsRequired- integer
Minimum: 0.
effectiveLimitRequired- integer
Minimum: 0.
usedRequired- integer
Minimum: 0.
reservedRequired- integer
Minimum: 0.
remainingRequired- integer
Minimum: 0.
projectedExhaustionAtRequired- string or null
May be null.
projectedExhaustionAt fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
Use MonitoringForecast in a workflow
Used by
Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.
- GET /monitoringResponse · Read monitor health, controls and estimated period capacity
- GET /usageResponse · Read period allowance, used subjects and pending reservations