Reports API
Available reports
To retrieve a list of available reports, make a GET
request to https://report-engine.transferzero.com/reports
, which takes the following optional querystring values. These parameters are used to filter the list of reports available. If they are not provided, you will simply receive a list of all reports for your API key.
type=transaction
oraccount
environment=test
orlive
https://report-engine.transferzero.com/reports?type=transaction&environment=test
You should then receive a response containing a list of reports available for download - example below:
Downloading a report
Now make a POST
request to https://report-engine.transferzero.com/authenticated_url
, with the body as the file name of the report you want to access:
This will return a time-sensitive URL, valid for 10 minutes - see example:
Either open this URL in a browser window or make a HTTP GET
request to download, you should now be able to access the data in the report.