Skip to content

[WIP] Get Statistics Record

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

Helix calls to get the statistics record by providing an array of annotationRequestId and pagination information, which can be used to workload 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. Possible values and their meanings are described in the Status Enum.
campaignIdstringUnique identifier for the campaign.
taskIdnumberID of the task.
poolIdnumberID of the pool.
poolTypenumberType of the pool.
folderIdnumberID of the team.
creatorIdnumberID of the creator of the record.
createdTimestring (representing a timestamp)Creation time of the record.
actionTypenumberAction code.
instanceInfoJsonThe sum of the values of how many instances of each action was modified is the same as that of instance_num
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.
frameCountnumberNumber of frames of the task.

TaskActionEnum Table

ValueDescription
0Initialization
1Pause
2Release
3Resume
4ERROR
5Distribute
6COMPLETE
7Submit annotation
8Check
9Sampling
10Reject
11Suspend
12Recycle
13Send task
14Dissolve
15Invalid
16Manual recycle
17Return from work pool

responses

2000
{
"code": 2000,
"message": "Success",
"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
}