How to get a dataset's KPIs summary
Steps to reproduce
- Log In to our platform (see Login).
- Create a New Project or use one created before.
- Create a New Dataset or use one created before.
- Get the
id_dataset
from the response - Run your Dataset.
- After your dataset execution is finished
"state": "Completed"
, you can get it's KPIs summary using this endpoint.
Request example
Endpoint
GET /api/v1/dataset/kpis/{id_project}/{id_dataset}
Path Parameters
Name | Value |
---|---|
id_project | 1 |
id_dataset | 1 |
Successful Response
{
"chartUnits": "m",
"units": "m",
"groups": [
"0-1",
"1-2",
"2-3",
],
"chart": [
["0-1", 10],
["1-2", 20],
["2-3", 0],
],
"average": 10,
"minimum": 0,
"maximum": 20,
"count": 50,
"area": 2500.5,
"code": 200
}