Querying the Monitoring Data of a Dataset
Function
This API is used to query the monitoring data of a dataset within a specified time range.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/datasets/{dataset_id}/metrics
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| dataset_id | Yes | String | Dataset ID. |
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| end_time | Yes | Long | End time of the monitoring information. |
| start_time | Yes | Long | Start time of the monitoring information. |
| workforce_task_id | No | String | ID of a team labeling task. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| metrics | Map<String,Map<String,Integer>> | Dataset monitoring information. |
Example Requests
Querying the Monitoring Data of a Dataset
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/metrics Example Responses
Status code: 200
OK
{
"metrics" : {
"un_annotation" : {
"1606233612612" : 16,
"1606320012681" : 16
},
"failed_user" : { },
"total" : {
"1606233612612" : 16,
"1606320012681" : 16
},
"queuing" : { },
"success" : { },
"unfinished" : { },
"manual_annotation" : {
"1606233612612" : 0,
"1606320012681" : 0
},
"failed" : { },
"failed_system" : { }
}
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.