GET data

Updated 1 week 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​ - External ID for the variable set up in Account settings→Statistics→Variable settings→ <select your Input Data(Variable)> → External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section Integration Keys
  • 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​ - External ID for the variable set up in Account settings→Statistics→Variable settings→ <select your Input Data(Variable)> → External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • ​externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section 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

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

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

  • ​externalForecastVariableId​ - External ID for the variable set up in Account settings→Statistics→Variable settings→ <select your Input Data(Variable)> → External ID
  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section 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

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

Getting the uploaded forecast data for the given forecast variable

  • externalForecastVariableId​ - External ID for the variable set up in Account settings→Statistics→Variable settings→ <select your Input Data(Variable)> → External ID​
  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section 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).

GET/calculated-variables/{extCalculatedVarId}

Getting the calculated output for a given calculated variable - Note that currently we do not support this action for calculated variables that include standard variables. This will be included in a future version.

  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit 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
  • extCalculatedVarId - The external variable ID for the calculated variable you want to get the data for. Found under Account Settings Variable Settings *Calculated Variable Name* External IDGET

GET/dynamic-rules

Retrieves dynamic rules set for a group, under Group Settings Dynamic Rules

  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section Integration Keys

GET/static-rules

Retrieves static rules set for a group, under Group Settings Static Rules

  • ​externalUnitId​ - External ID for a unit as set up for units in Account Settings Group Management *Unit Name* Unit Integration Keys
  • externalSectionId​ - External ID for a section as set up for sections in Account Settings → Group Management → *Section Name* → Section Integration Keys


How Did We Do?