Skip to content

Get Statistics Record

GEThttps://${domain}/rosetta-open/statistics/record

(Task record table)Helix calls to get the statistics record by providing an array of annotationRequestId and pagination information, which can be used to workload and deliver statistics and query the relevant annotation records.

query params

*annotationRequestIdstring[] Defaults to [ "7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b" ]
Unique identifier for the annotation request, with a maximum length of 255 bytes.
*offsetnumber Defaults to 1
The page number for pagination, starting from 1.
*limitnumber Defaults to 10
The number of records per page, a positive integer.By default, protect the maximum value of the server is 1000.
Examples
shell
curl https://${domain}/rosetta-open/statistics/record?annotationRequestId=7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b&offset=1&limit=10 \
 -X GET \
 -H 'Content-Type: application/json' \
 -H 'X-STARDUST-KEY: <X-STARDUST-KEY>' \
 -H 'X-TS: <X-TS>' \
 -H 'X-SIGN: <X-SIGN>'

Response Field Descriptions

Field NameTypeDescription
idnumberUnique identifier of the annotation history record.
statusnumberStatus of the task
campaignIdstringUnique identifier for the campaign.
taskIdnumberID of the task
poolNameStringName of the pool.
poolTypenumberType of the pool
folderIdnumberID of the folder.
aliceNamestringThe alice user name.
createdTimestring (representing a timestamp)Creation time of the record.
actionTypenumberRecord action classification type.
instanceInfoJsonThe modification quantity of each operation item. This is a detailed explanation of modifyInstanceNum+modifyAttributesNum. If modifyInstanceNum+modifyAttributesNum is 0, it is empty here
modifyInstanceNumnumberNumber of submitted annotation instances. Only this manual modification and the new instance will be in the count range.
modifyAttributesNumnumberNumber of submitted annotation attributes. Only this manual modification and the new instance will be in the count range.
instanceSumnumberTotal number of instances at that time.
attributesSumnumberTotal number of task attributes at that time.

TaskActionEnum Table

ValueDescriptionExplanation
0InitializationTask is successfully created
5DistributeTask is assigned from a distribution pool to a downstream work pool.For example, in the workflow, assign tasks from the distribution pool to the Annotation pool.
1PauseThe action of clicking Pause button to pause the task.The paused task cannot be allocated, labeled, checked, or spot-checked. If the task has already been claimed, it will be released at the same time as it is paused.
2ReleaseThe action of clicking Release button to free the tasks from the current user to the work pool for other users to claim
3ResumeResume task from paused state to normal
6Back taskThe task is returned from the completion pool to the last pool
7Submit annotationSubmitting Tasks from annotation pool
8CheckThe action of a task being checked in the review pool
9SamplingThe action of a task being quality checked in the sampling pool
10RejectTask is rejected from sampling pool to review pool or annotation pool
13Accept the taskTasks are picked up by the labeler or quality analyst.That is, start working in the work pool.
14DissolveThe task is disbanded from the sampling package of the sampling pool and released back to the sampling pool
17Return from work poolTask is returned from the review pool to the annotation pool
18Open label data exportTask annotation results are converted into OpenLabel format data.

responses

2000
{
"code": 2000,
"message": "Success",
"data": {
"count": 1930,
"data": [...]
},
"date": "2025-04-08 14:20:00",
"requestId": "9876543210abcdef9876543210abcdef",
"success": true
}
5000
{
"code": 5000,
"data": null,
"message": "Service hiccuped, please try again later.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
53003
{
"code": 53003,
"data": null,
"message": "Annotation request has not exists.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}