Data Export Feature
The Data Export feature lets you schedule large reports to run overnight. These results are then cached for you to retrieve via API the following day or via the Documents > Data Export folder.
Status: Beta testing. Submit a Help menu > Support Request from your site if you want to be considered for beta testing.
Cost: To be determined.
Configuration
If you go to Reports -> Actions -> Scheduled Reports, you will see that the list view now has two + icons to it. One of the icons allows you to create Scheduled Data Export Reports.
This uses the same options as the Scheduled Reports to configure. Once the report is saved, you can also generate the report by clicking "Send Now" in the listview.
Best Practice is to make the JSON Report Component available via this, not the tabular data from excel or XML.
Retrieving Data Export
Results can be retrieved via the Documents > Data Export folder, or via API.
The API Documentation is available with our general API Documentation. There are endpoints for Searching all Data Export Reports, Getting a specific Data Export Report, and then getting the Latest version of a Data Export Report.
Your API User needs to have the User Role Permission API Get Data_Export enabled.
You can then make a GET API call to /api/v2/data_export/ to get details about any particular data runs.
Best practice is to filter by sort=DESC and report_schedule_id=101 where 101 is the ID value of the scheduled Data Export. You can get this number from the URL when editing an existing Data Export Schedule. It will pair with rs_id= in the URL.
A GET API call to /api/v2/data_export/data/{UUID} will download the results of that API call. Since the data is cached, it is pretty quick to respond.
There are also /api/v2/data_export/report/{report_schedule_id}/latest/data and /api/v2/data_export/report/{report_schedule_id}/latest/info endpoints to always query the latest version of the report.