GET data

Updated 2 months ago by Stephan Hale

Get data from Quinyx

To be able to retrieve data from Quinyx to be used in other BI systems or similar there are available API´s for this

Api-docs for rc : https://api-rc.quinyx.com/v2/docs

Api-docs : https://api.quinyx.com/v2/docs

GET /forecast-variables/{externalForecastVariableId}/actual-data

Getting the actual data previously uploaded for the given forecast variable 

  • ​externalForecastVariableId​ - ID for a variable as set up for units in Account settingsStatisticsInput Data→ <select your variable> External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Classic → Settings → Tables → integration keys
  • ​externalSectionId​ - External ID for a section as set up for units in Classic → Settings → Tables → integration keys (optional)
  • startTime - Start of the period you want to GET data for
  • endTime - End time of the period you want to GET data for

GET /forecast-variables/{externalForecastVariableId}/aggregated-data

Getting the aggregated data that has previously been uploaded for the given forecast variable with /raw-data

  • ​externalForecastVariableId​ - ID for a variable as set up for units in Account settingsStatisticsInput Data→ <select your variable> External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Classic → Settings → Tables → integration keys
  • ​externalSectionId​ - External ID for a section as set up for units in Classic → Settings → Tables → integration keys (optional)
  • startTime - Start of the period you want to GET data for
  • endTime - End time of the period you want to GET data for

GET /forecast-variables/{externalForecastVariableId}/calculated-forecast

Getting the calculated forecast data and the possibly edited data for the same configuration

  • ​externalForecastVariableId​ - ID for a variable as set up for units in Account settingsStatisticsInput Data→ <select your variable> External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Classic → Settings → Tables → integration keys
  • ​externalSectionId​ - External ID for a section as set up for units in Classic → Settings → Tables → integration keys (optional)
  • startTime - Start of the period you want to GET data for
  • endTime - End time of the period you want to GET data for

GET /forecast-variables/{externalForecastVariableId}/budget-data

Getting the uploaded forecast data for the given forecast variable

  • ​externalForecastVariableId​ - ID for a variable as set up for units in Account settingsStatisticsInput Data→ <select your variable> External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Classic → Settings → Tables → integration keys
  • ​externalSectionId​ - External ID for a section as set up for units in Classic → Settings → Tables → integration keys
  • startTime - Start of the period you want to GET data for
  • endTime - End time of the period you want to GET data for

Limit for a range of time is 120 days. You are also not allowed to use more than 5 concurrent requests (eg. running more than 5 threads simultaneously per unique customer regardless of endpoint).


How Did We Do?