POST Standard Variables in Statistics

Updated by Daniel Sjögren

Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select "statistics" definition)

Api-docs: (will be made available as of version 0185) https://api.quinyx.com/v2/docs (select "statistics" definition)

Base URL can be found on links above for both environments. The remainder of this article should be considered a complement to the above Open API documentation.

Path properties

POST/standard-variables

This endpoint will return standard variables based on the period and the standard variable you define. 

Payload Details

  • groupIds: List of group ID’s 
    • groupIds: [12345]
  • period: Time period for the standard-variables
    • start: Start date and time in ISO 8601 format 
    • end: End date and time in ISO 8601 format
    • aggregation-type: Type of aggregation (e.g. “H” for Hourly)
    • aggregation-value: Value for the aggregation type (e.g. 1)
  • variables: List of standard-variables to be included. As of now three of them are excluded from this api.
    • scheduled-hours: type of variable
  • baseScheduleData: Not used, set to “null”, (will be removed later)
  • displayItems: Items to be displayed
  • statisticsFilterTypes: Logical operator for statistics filter
  • people-filter-type: Logical operator for people filters
  • shifts-filter-type: Logical operator for shifts filters
  • tasks-filter-type: Logical operator for tasks filters
  • punches-filter-type: logical operator for punches filters
  • absences-filter-type: logical operator for absences filters
  • filters: Not used but needed in the payload (will be removed later)

Request Payload example

{
"groupIds": [
0
],
"period": {
"start": "2024-05-29T07:45:25.988Z",
"end": "2024-05-29T07:45:25.988Z",
"aggregation-type": "m",
"aggregation-value": 0
},
"variables": [
"scheduled-hours"
],
"filters": [
{
"name": "employee",
"values": [
0
]
}
],
"baseScheduleData": {
"baseScheduleId": "string",
"dayIndex": 0
},
"baseScheduleIds": [
"string"
],
"displayItems": [
"people"
],
"statisticsFilterTypes": "and",
"people-filter-type": "and",
"shifts-filter-type": "and",
"tasks-filter-type": "and",
"punches-filter-type": "and",
"absences-filter-type": "and"
}


How Did We Do?