OrganizationUnitID is the organization unit you want data from; this may be a container unit or a shop alike
Labels define the data you want to retrieve; use GetLabels to find the available labels in this instance
Timeframe defines the range of dates you want to accumulate, where you have three options available;
A Period with a Year and then either a Month or a Week (ISO)
A Range with a From and To date and a Grain to define the amount of detail within this period
A Date for a single date point in time
Optionally, you can supply the following parameters;
Series is an array where you can specify which Series to retrieve; current values include Actual and LFL
GroupBy defines the 'rotation' to view the data in; by default you'll see data per Label, but you can rotate for a ranking view using OrganizationUnit or a more detailed view using Name
Mock allows you to override the base BI:Mock setting to switch between mocked- and live data
Gets BI data based on the given Labels.
OrganizationUnitID
is the organization unit you want data from; this may be a container unit or a shop alikeLabels
define the data you want to retrieve; useGetLabels
to find the available labels in this instanceTimeframe
defines the range of dates you want to accumulate, where you have three options available;Period
with aYear
and then either aMonth
or aWeek
(ISO)Range
with aFrom
andTo
date and aGrain
to define the amount of detail within this periodDate
for a single date point in timeOptionally, you can supply the following parameters;
Series
is an array where you can specify whichSeries
to retrieve; current values includeActual
andLFL
GroupBy
defines the 'rotation' to view the data in; by default you'll see data perLabel
, but you can rotate for a ranking view usingOrganizationUnit
or a more detailed view usingName
Mock
allows you to override the baseBI:Mock
setting to switch between mocked- and live data