Dashboard

/dashboard

GET apiURL/dashboard

Get all dashboard KPIs (for the current user)

Query Parameters

Name	Type	Description
fields	string
limit	number
orderby	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of DashboardKpi

{
  "data": [
    {
      "call": "device-count-total",
      "orderby": 36,
      "x": null,
      "y": null,
      "type": "counter",
      "label": "Nb. boîtiers créés (total)"
    },
    {
      "call": "device-count-last-day",
      "orderby": 37,
      "x": null,
      "y": null,
      "type": "counter",
      "label": "Nb. boîtiers créés (hier)"
    }
  ],
  "total": 34,
  "skip": 0,
  "limit": 2,
  "orderby": [
    "orderby"
  ]
}

/dashboard/kpi/:call

GET apiURL/dashboard/kpi/:call

Get dashboard KPI datas by call (for the current user)

Path Parameters

Name	Type	Description
call	string	Dashboard call ID ex: device-count-last-day

200 See DashboardKpiData page

counter

counter

{
  "type": "counter",
  "name": "DEVICE_COUNT_LAST_DAY",
  "value": 0,
  "date_range": [
    "2018-10-28",
    "2018-10-28"
  ],
  "history": [
    {
      "label": "PREV_DAY",
      "value": 0,
      "date_range": [
        "2018-10-27",
        "2018-10-27"
      ]
    },
    {
      "label": "PREV_WEEK",
      "value": 0,
      "date_range": [
        "2018-10-21",
        "2018-10-21"
      ]
    },
    {
      "label": "PREV_MONTH",
      "value": 0,
      "date_range": [
        "2018-09-28",
        "2018-09-28"
      ]
    },
    {
      "label": "PREV_YEAR",
      "value": 0,
      "date_range": [
        "2017-10-28",
        "2017-10-28"
      ]
    }
  ]
}

line

line

{
  "type": "line",
  "name": "TRIP_DISTANCE_DAILY",
  "x_axis": {
    "type": "date",
    "range": [
      "2016-09-11",
      "2018-09-12"
    ]
  },
  "y_axis": {
    "type": "number",
    "range": [
      0,
      1000
    ]
  },
  "lines": [
    {
      "dots": [
        {
          "x": "2018-09-12",
          "y": 1
        },
        {
          "x": "2018-09-03",
          "y": 0
        }
      ]
    }
  ]
}