GET AI-scheduled-headcount
Updated
by
Daniel Sjögren
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “statistics” definition)
Api-docs: 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.
GET /groups/{groupId}/ai-scheduled-headcount/{shiftTypeId}
This API call fetches AI scheduled headcount. The requested period must not exceed 120 days.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The group ID of the group you want to fetch the schedule headcount data.
- shiftTypeId*: The ID of the shift type you want to fetch.
- start*: Start date and time for the period you want to fetch the scheduled headcount.
- end*: End date and time for the period you want to fetch the scheduled headcount.
Response
- variable: The name of the scheduled headcount.
- resolution: The step that Quinyx calculates the data for, e.g. 15 min.
- value: The headcount for the day/period.
- total-value: The total headcount for the entire timespan.
Example
End point
For the production environment: https://api.quinyx.com/v2/statistics/groups/261825/ai-scheduled-headcount/773757?start=2024-11-05T13:54:05.174Z&end=2024-12-05T13:54:05.174Z
For the RC environment: https://api-rc.quinyx.com/v2/statistics/groups/261825/ai-scheduled-headcount/773757?start=2024-11-05T13:54:05.174Z&end=2024-12-05T13:54:05.174Z
For the RC environment: https://api-rc.quinyx.com/v2/statistics/groups/261825/ai-scheduled-headcount/773757?start=2024-11-05T13:54:05.174Z&end=2024-12-05T13:54:05.174Z
Response body
{
"variable": "string",
"resolution": 15,
"values": [
{
"start": "2024-11-05T13:58:30.172Z",
"end": "2024-11-05T13:58:30.172Z",
"value": 0.0,
}
],
"total-value": 0.0
}