API REFERENCE · SCHEMA
MonitorEventPage 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 schemasitemsRequired- MonitorEvent[]
items item fields
Each array item: MonitorEvent.
items[]Required.id - string
Format: uuid.
items[]Required.monitorId - string
Format: uuid.
items[]Required.monitorName - string
items[]Required.caseId - string or null
May be null.
items[].caseId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
items[]Required.screeningId - string or null
May be null.
items[].screeningId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
items[]Required.previousScreeningId - string or null
May be null.
items[].previousScreeningId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
items[]Required.kind - string
Values: "initial_match", "match_added", "match_removed", "evidence_changed", "policy_changed", "baseline_unavailable", "screening_failed", "screening_overdue", "screening_recovered", "review_required".
items[]Required.status - string
Values: "unread", "acknowledged".
items[]Required.createdAt - string
Format: date-time.
items[]Required.acknowledgedAt - string or null
May be null.
items[].acknowledgedAt fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
items[]Required.errorCode - string or null
Public screening failure code, or null when the event does not represent an error. Infrastructure details are not returned; temporarily_unavailable and screening_failed are generic fallbacks. Unknown future codes must remain a failed or incomplete check, never no_match.
May be null.
items[].errorCode fields and rules
Allowed alternatives
- string
- null
May be null.
items[]Required.totalChanges - integer
Total saved changes before preview limits.
Minimum: 0.
items[]Required.evidenceExpired - boolean
True if linked current or prior evidence is unavailable under retention; missing preview content is not proof of no change.
items[]Required.currentEvidenceAvailable - boolean
items[]Required.previousEvidenceAvailable - boolean
items[]Required.changes - object[]
Bounded change previews: at most 10 per list item or 25 on detail. Use linked retained screening IDs for complete evidence.
items[].changes item fields
Each array item: object.
items[]Required.changes[] .sourceId - string
items[]Required.changes[] .recordId - string
items[]Required.changes[] .kind - string
Values: "added", "removed", "changed".
items[]Required.changes[] .fields - string[]
items[].changes[].fields item fields
Each array item: string.
items[]Optional.changes[] .before - object
Prior retained evidence preview; omitted when the record did not exist or prior evidence is unavailable.
View MonitorRecordPreview schema items[].changes[].before fields and rules
See all MonitorRecordPreview fields for the complete structure, required properties and constraints.
items[]Optional.changes[] .after - object
Current retained evidence preview; omitted when the record no longer exists or current evidence is unavailable.
View MonitorRecordPreview schema items[].changes[].after fields and rules
See all MonitorRecordPreview fields for the complete structure, required properties and constraints.
nextCursorRequired- string or null
May be null.
nextCursor fields and rules
Allowed alternatives
- string
- null
May be null.
unreadCountRequired- integer
Minimum: 0.