Reports Transactions Export

This endpoint for creating an export file of a selection of transactions

Reference

POST /reports/transactions/export


Fields

field type constraints Req
userId int The userId Yes
portal string Available options: No
- marktplaats
- tweedehands
feature boolean/string Available options: No
false -> show all publish + feature transactions
empty -> show only publish-transactions
marktplaats
- omhoogplaatsen
- dagtopper
- dagtopper3
- dagtopper7
- homepaginaAdvertentie
- url
tweedehands
- omhoogplaatsen
- dagtopper
- dagtopper3
- dagtopper7
- homepaginaAdvertentie
- url
dateStart datetime No
dateEnd datetime No
result boolean true -> only show items who are succesfully processed. No
false -> show all transactions (default)
format string Default: xlsx No
Available options:
- xlsx
- csv
- json
- xml
url boolean/string Default: true No
true -> return a URL for downloading the exportfile
false -> direct download of binary data
Please note: authentication-token has to be provided when downloading the report, just like any other endpoint.
The url will only be valid for a period of 10 minutes.
After the file has been downloaded, it is automatically removed.


Example

Request

POST /rest/v1/reports/transactions/export HTTP/2
{
 "userId": 12311,
 "dateStart": "2019-01-01 00:00:00",
 "dateEnd": "2020-01-01 00:00:00",
 "format": "xlsx",
 "url": true
}

Response

{
 "result": true,
 "errors": [],
 "data": {
   "userId": 12311,
   "dateStart": "2019-01-01 00:00:00",
   "dateEnd": "2020-01-01 00:00:00",
   "format": "xlsx",
   "url": "https://api.goedgeplaatst.nl/rest/v1/reports/download/api_reports_transactions_12996OiD6HQ.xlsx"
 }
}