Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quinyx Forecast Data API

The Forecast Data API from Quinyx — 16 operation(s) for forecast data.

Quinyx Forecast Data API is one of 35 APIs that Quinyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Forecast Data. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 16 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.quinyx.com, https://api-rc.quinyx.com.

20 operations 16 paths 12 schemas 4 DELETE9 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.eu.quinyx.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Quinyx Forecast Data API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (employee_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (opening-hours_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (organisation_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (rest-api-uaa_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule-availability_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (statistics_OAuth2ClientCredentials) using the clientCredentials flow.

  • employee_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • opening-hours_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • organisation_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • rest-api-uaa_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule-availability_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • statistics_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 4 DELETE, 9 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Forecast Data 20
POST
/v2/forecasts/raw-datadeprecated
Upload actual data with maximum 366 rows
postRawData 1 param body → 200403
POST
/v2/forecasts/predicted-data
Upload prediction data with maximum 366 rows at the variable resolution
postPredictedData body → 200400403
POST
/v2/forecasts/forecast-variables/{externalForecastVariableId}/forecast-configurations/{externalForecastConfigurationId}/edit-forecast
Update forecast configuration and related data
editCalculatedForecast 4 params body → 200400403
POST
/v2/forecasts/forecast-datadeprecated
Upload forecast data with maximum 366 rows
postForecastData 1 param body → 200403
POST
/v2/forecasts/budget-data
Upload budget data with maximum 366 rows
postBudgetData 1 param body → 200403
POST
/v2/forecasts/aggregated-data
Upload pre-aggregated data with maximum 366 rows
postAggregatedData body → 200403
POST
/v2/forecasts/actual-data
Upload actual data with maximum 366 rows
postActualData 1 param body → 200403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/raw-datadeprecated
Get uploaded raw data for forecast variable, up to 120 days
getRawData 5 params → 200403
DELETE
/v2/forecasts/forecast-variables/{externalForecastVariableId}/raw-datadeprecated
Delete uploaded raw data and matching calculated forecast
deleteRawData 5 params → 202403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/raw-data-streamdeprecated
Stream uploaded raw data for forecast variable, up to 120 days
getRawDataStream 5 params → 200403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/forecast-datadeprecated
Get uploaded forecast data for a forecast variable, up to 120 days
getUploadedForecastData 5 params → 200403
DELETE
/v2/forecasts/forecast-variables/{externalForecastVariableId}/forecast-datadeprecated
Delete previously uploaded forecast data for a forecast variable
deleteForecastData 5 params → 202403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/calculated-forecast
Get the calculated forecast for a forecast variable, ignoring forecast events
getCalculatedForecastForVariable 5 params → 200403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/budget-data
Get uploaded budget data for a forecast variable, up to 120 days
getUploadedBudgetData 5 params → 200403
DELETE
/v2/forecasts/forecast-variables/{externalForecastVariableId}/budget-data
Delete previously uploaded budget data for a forecast variable
deleteBudgetData 5 params → 202403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/aggregated-data
Get aggregated data for a forecast variable, up to 120 days
getAggregatedData 5 params → 200403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/actual-data
Get previously uploaded actual data for a forecast variable, up to 120 days
getActualData 5 params → 200403
DELETE
/v2/forecasts/forecast-variables/{externalForecastVariableId}/actual-data
Delete previously uploaded actual data and the matching calculated forecast
deleteActualData 5 params → 202403
GET
/v2/forecasts/forecast-variables/{externalForecastVariableId}/actual-data-stream
Stream previously uploaded actual data for a forecast variable, up to 120 days
getActualDataStream 5 params → 200403
GET
/v2/forecasts/calculated-variables/{extCalculatedVarId}
Get calculated variable data by external id, up to 120 days
getCalculatedVariableData 4 params → 200403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are forecast-data-ingestion_ForecastPredictionDataInput (7 properties), forecast-data-ingestion_AggregatedData (7 properties), forecast-data-ingestion_DataIngestionOutput (5 properties), forecast-data-ingestion_CalculatedForecast (5 properties). Each schema is shown below with its type and property counts.

forecast-data-ingestion_CalculatedForecastData
object
4 properties
forecast-data-ingestion_ForecastDataPayload
object
2 properties 2 required
forecast-data-ingestion_ForecastPredictionDataInput
object
7 properties 6 required
forecast-data-ingestion_ForecastPredictionIntegrationList
object
1 property 1 required
forecast-data-ingestion_Payload
object
2 properties 2 required
forecast-data-ingestion_DataProviderInput
object
4 properties 3 required
forecast-data-ingestion_DataProviderInputList
object
1 property 1 required
forecast-data-ingestion_DataIngestionOutput
object
5 properties
forecast-data-ingestion_AggregatedData
object
7 properties
forecast-data-ingestion_CalculatedVariableOutput
object
4 properties
forecast-data-ingestion_ForecastDataModifier
object
4 properties 2 required
forecast-data-ingestion_CalculatedForecast
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-forecast-data-api-openapi.yml Raw ↑

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API
Quinyx Absence Types API
Quinyx Absences API
Quinyx Access Token API
Quinyx Agreements API
Quinyx AI Scheduled Headcount API
Quinyx Authentication API
Quinyx Collaboration Groups API
Quinyx Collaboration Groups Labels API
Quinyx Employee API
Quinyx Employees API
Quinyx Forecast Dynamic Rules API