Introduction

The Data export API can be used to programmatically download the CSV exports configured via the Alcméon user interface. These exports are CSV files, packaged in a ZIP file: their format is documented separately.

Step by step

1. Configure an export in the Alcméon user interface, make sure you track the name of this export
2. GET /exports to find the export_id matching the export name you just created
3. Once every hour, GET /exports/{export_id}, to download the export zip file.
4. Check the Last-Modified header returned from GET /exports/{export_id}. If it is more recent than your last successful import, then you should process it.

FAQ

Can I download older exports ?

The above API makes no provision for downloading the exports generated previously: the previously-generated export is deleted when a new export is generated.

How is the export stored in your infrastructure ?

This export is stored encrypted at rest. It is decrypted on the fly upon calls to GET /exports/{export_id}