For Developers

Enrichments Overview

An Enrichment is a background job that reconciles multiple linked sources (e.g. merging student identifiers from an SIS with activity and grade data from an LMS) into unified records in the regional database.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the enrichment execution run.
created_dateDateWhen the enrichment was queued.
updated_dateDateLast modification time.
heartbeat_dateDateLast time the enrichment worker reported progress.
stateStringExecution status: queued, working, complete, or error.
source_idUUIDPrimary source ID for this enrichment.
priorityNumberQueue priority.

JSON Example

{
    "id": "e931b9fa-7104-4c8d-8bb4-0980fa2a5c11",
    "created_date": "2024-06-21T07:00:00.000Z",
    "heartbeat_date": "2024-06-21T07:15:00.000Z",
    "state": "complete",
    "source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12"
}