Base payload
Every event will have the following top level fields
| Key | Type | Description |
|---|
uid | string | Unique identifier of the event |
version | integer | Major version number to indicate backwards incompatible versions |
source | string | Will always be the string "Encord" |
event_type | string | The event type. See below for more info. |
event_created_timestamp | string | A string of the timestamp in the ISO 8601 format. For example 2022-04-13T14:35:11.791161+00:00 |
payload | object | An object with different fields depending on the type of event. See below for more info. |
Individual event payloads
Task submitted payload
event_type: task_submitted_event
Payload
| Key | Type | Description |
|---|
project_hash | string | The unique identifier for the project. |
Task completed payload
event_type: task_completed_event
Payload
| Key | Type | Description |
|---|
project_hash | string | The unique hash identifier for the project. |
label_hash | string | The unique hash identifier for the label. |
Full digest payload
event_type: digest_event
Payload
| Key | Type | Description |
|---|
projects_stats | array | Array of ProjectStats objects |
ProjectStats
Please note that the summary statistics are all for the time frame of the daily digest. This is currently 24h.
| Key | Type | Description |
|---|
project_hash | string | The unique hash identifier for the project. |
annotator_stats | array | Array of AnnotatorStats objects |
reviewer_stats | array | Array of ReviewerStats objects |
AnnotatorStats
| Key | Type | Description |
|---|
user_email | string | Email address of the user |
submitted_labels | integer | Number of labels the user has submitted |
accepted_labels | integer | Number of labels that were accepted by a reviewer |
rejected_labels | integer | Number of labels that were rejected by a reviewer |
avg_time_for_add | Optional[float] | Average time it took for the annotator to add a label in milliseconds. This field is optional. |
avg_time_for_edit | Optional[float] | Average time it took for the annotator to edit a label in milliseconds. This field is optional. |
rejection_rate | float | The number of rejected labels over all rejected and approved labels. |
total_add_or_edit_time | float | Total time it took for adding and editing labels in milliseconds. |
ReviewerStats
| Key | Type | Description |
|---|
user_email | string | Email address of the user |
reject_count | integer | Number of labels rejected |
accept_count | integer | Number of labels accepted |
average_time | float | Average time it took to process a single review |
reviews_count | integer | Total number of reviews |
total_time | float | Total time spent on reviews |
rejection_rate | float | Rejected reviews over all reviews |