GET Data

Updated by Victor Jespersen

Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “collaboration-groups” definition)

Api-docs: https://api.quinyx.com/v2/docs (select “collaboration-groups” 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}/optimal-headcounts

This API call edits a collaboration group by ID.

Field description

Mandatory fields will be marked with a * icon.

Endpoint
  • startTime*: Start date and time for the period you want to calculate the optimal headcount.
  • endTime*: End date and time for the period you want to calculate the optimal headcount.
  • groupId*: The group ID for the group you want to fetch data from.
Body

This API call has no body.

Response
  • optimalHeadcountId: The ID of the optimal headcount.
  • shiftTypeId: The ID of the shift type used in the schedule.
  • datasetsByGroupId: The group ID of the group from which you fetch the data.
    • start: Start date and time for the period you've selected for the calculation of the optimal headcount.
    • end: End date and time for the period you've selected for the calculation of the optimal headcount.
    • value: The headcount value.
    • editedValue: The user edited headcount value.
    • runId: The ID of the optimal headcount algorithm run.
    • runTimeStamp: The timestamp(Date and time) of the optimal headcount algorithm rum.
  • summaryValue: The total value.
  • editedSummaryValue: The user edited total value.
  • resolution: The step Quinyx calculates the data for. e.g 15 minutes.

Example

End point
For the production environment:https://api.quinyx.com/v2/forecast-calculation/groups/1234/optimal-headcounts?startTime=2024-11-12T09:51:22.941Z&endTime=2024-12-12T09:51:22.941Z

For the RC environment: https://api-rc.quinyx.com/v2/forecast-calculation/groups/1234/optimal-headcounts?startTime=2024-11-12T09:51:22.941Z&endTime=2024-12-12T09:51:22.941Z
Response
[
{
"optimalHeadcountId": "string",
"shiftTypeId": 0,
"datasetsByGroupId": {
"additionalProp1": {
"data": [
{
"start": "2024-11-12T09:56:30.006Z",
"end": "2024-11-12T09:56:30.006Z",
"value": 0,
"editedValue": 0,
"runId": "string",
"runTimeStamp": "2024-11-12T09:56:30.006Z"
}
]
}
}
}
]

How Did We Do?