Aggregated Data Export

Select metrics and receive their totals.

get
Aggregated Data

https://api.roivenue.com​/api​/export​/v1​/{datasetCode}​/aggregation
The aggregation function allows you to choose the dimensions and metrics that interest you and receive the calculated totals. For example: you can request a date by date list of totals, or a list of campaigns with their details. Filtering In addition to the parameters listed below, it is possible to include additional filters in the query and potentially reduce the amount of data. - Example of selecting only some values: salesChannel=val1,val2... - Example of excluding some values: dataPartitionCode=~val1,val2 Limits: Maximum number of rows in a result is 100,000. Use filtering or a date range to limit the number of rows in the result.
Request
Response
Request
Path Parameters
datasetCode
required
string
Currently we support three possible datasets: ‘orders’, ‘customers’ and ‘performance’.
Query Parameters
teamCode
required
string
Your team's Roivenue's ID. Example ‘mycompany’
token
required
string
Access token (JWT) is a special access code defined for a combination of user, team, and dataset. The access token can be created in the Roivenue Application.
dateFrom
optional
string
string(date-time) First date of requested dataset. When ‘dateFrom’ and ‘dateTo’ is specified ‘daysBack’ is ignored.
dateTo
optional
string
string(date-time) Last date of requested dataset. When 'dateFrom' and 'dateTo' is specified 'daysBack' is ignored.
daysBack
optional
integer
(int32) The length of a sliding time window as number of closed days. E.g ‘1’ returns yesterday’s data. Default number of days is 14. This option is ignored, if ‘dateFrom’ and ‘dateTo’ is specified.
timeGranularity
optional
integer
(int32) Time granularity can be defined for a Performance dataset. Other datasets ignore this parameter. Available options: ‘monthly’, ‘weekly’, ‘daily’. Default option is ‘daily’. Available values: 0, 1, 2
currency
optional
string
Financial measures can be obtained in a several currencies according to the historical daily exchange rate list given by the European Central Bank. Currency is represented by three letter ISO code. Available currencies: CZK, EUR, GBP, USD, PLN, HUF, RON, NOK, SEK. Default option is ‘EUR’.
dimensions
optional
string
Comma separated list of default or custom dimensions. By default no dimension is selected. A complete list of dimensions can be obtained using the dataset-info method. Example: ‘period,adGroup, ... ’
measures
optional
string
Comma separated list of measures available in a given dataset. By default, all default measures are included. The calculated measures are not part of the default measures and can be specified manually. A list of all available measures in a given dataset can be obtained using the dataset-info method. Example: ‘impressions,clicks,visits
attributionModel
optional
string
Available options are: LastTouch, FirstTouch, TimeDecay or RnnProbability. Default attribution model option is LastTouch.
output
optional
integer
($int32) Output data format. Available options: ‘JSON’ (0) and ‘CSV’ (1). Default output data format is CSV(1). Available values : 0, 1
Response
200: OK
Data successfully retrieved.
401: Unauthorized
The necessary credentials are missing.
403: Forbidden
The server is refusing the request based on the given credentials.