Skip to content

How to get a dataset's KPIs summary

Steps to reproduce

  1. Log In to our platform (see Login).
  2. Create a New Project or use one created before.
  3. Create a New Dataset or use one created before.
  4. Get the id_dataset from the response
  5. Run your Dataset.
  6. 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
}