Sign in

v1

latestOpenAPI 3.1.02026-08-06118124285.7 KB
Standard Variables

List standard variables

Fetches standard variables from the statistics service.

post/v2/statistics/standard-variables

Request body

groupIdsinteger[]
variablesstring[]
baseScheduleIdsstring[]
displayItemsstring[]
laborViewboolean
statisticsFilterTypes'and' | 'or'
people-filter-type'and' | 'or'
shifts-filter-type'and' | 'or'
tasks-filter-type'and' | 'or'
punches-filter-type'and' | 'or'
absences-filter-type'and' | 'or'

Example request

{
  "period": {
    "start": "2026-01-01T00:00:00",
    "end": "2026-01-31T23:59:59",
    "aggregation-type": "D",
    "aggregation-value": 1
  },
  "filters": [
    {
      "name": "employee",
      "timeRange": {
        "enabled": true,
        "from": "08:00",
        "to": "17:00"
      }
    }
  ],
  "baseScheduleData": {
    "baseScheduleId": "abc123"
  },
  "statisticsFilterTypes": "and",
  "people-filter-type": "and",
  "shifts-filter-type": "and",
  "tasks-filter-type": "and",
  "punches-filter-type": "and",
  "absences-filter-type": "and"
}

Response

OK

variable'scheduled-hours' | 'worked-hours' | 'leave-hours' | 'optimal-hours' | 'forecast-hours' | 'forecast-sales' | 'actual-sales' | 'actual-staff-cost' | 'forecast-staff-cost' | 'base-schedule-hours' | 'productive-hours' | 'kpi-scheduled-hours' | 'kpi-scheduled-hours-excl-ut' | 'kpi-worked-hours' | 'scheduled-staff-cost' | 'scheduled-staff-cost-excluding-absences' | 'scheduled-hours-excluding-absences' | 'worked-hours-excluding-absences' | 'expected-staff-cost' | 'scheduled-break-hours' | 'punched-break-hours' | 'base-schedule-cost' | 'expected-kpi-scheduled-hours' | 'expected-kpi-worked-hours'
total-valuenumber double

Example response

[
  {
    "variable": "scheduled-hours",
    "values": [
      {
        "start": "2026-01-01T00:00:00",
        "end": "2026-01-01T23:59:59",
        "value": 100,
        "employeeId": 1
      }
    ],
    "total-value": 100
  }
]