Source Data Export

Raw list of data from a specified dataset.

get
General List of Records

https://api.roivenue.com/api/export/v1/{datasetCode}/list
The list function gives you the requested records without any aggregation. Filtering In addition to the parameters listed below, it is possible to include additional filters for any dimension 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 result is 100,000. Use filtering or a date range to limit the number of rows in 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. Access token can be created in Roivenue or with API method ‘CreateToken’.
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 a 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.
attributionModel
optional
string
Available options are: LastTouch, FirstTouch, TimeDecay or RnnProbability. Default attribution model option is LastTouch.
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
columns
optional
string
Comma delimited list of column names. By default all available columns are included.
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’.
sortBy
optional
string
Comma delimited list of column codes, default is ‘periodCode desc’.
limit
optional
integer
(int32) Number of records in a result. Maximum number of rows is 100,000.
offset
optional
integer
(int32) Offset of start of data. This is being used for paging.
output
optional
integer
(int32) Output data format. Available options: ‘JSON’ and ‘CSV’ . Default output data format is CSV. 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.