Programmatic Exports

Unit21 provides agents the ability to export your data via our APIs.

If you need to have information exported, your engineering team can:

1. GENERATE AN EXPORT:

Use endpoints to bulk export SARs, instruments, entities, and more, for example:
https://docs.unit21.ai/reference/export_entities

2. SETUP A FILE READY WEBHOOK:

Subscribe to the File Ready to Download webhook to get a notification when the export is ready:
https://docs.unit21.ai/reference/file-export-webhook-reference

or

2. VIEW THE EXPORT STATUS:

Use the export status endpoint to view the status of your request:
https://docs.unit21.ai/reference/list_exports

3. DOWNLOAD THE EXPORT:

Use the download endpoint to get a URL to download the file at:
https://docs.unit21.ai/reference/download_file_export

❗️

Exports that fail will not be automatically regenerated.

If your export fails, you must make a new request to generate the export.

You can use programmatic exports to:

  1. Have your engineers orchestrate with a few of our API endpoints
  2. Have exports automatically queued up (at your requested cadence)
  3. Create a webhook subscribed to File Export Ready to Download
  4. Optionally check the status of your exports automatically and be notified when they’re ready
  5. Download the file directly from S3 in a secure manner (no more emailed exports)
  6. Load it automatically into your datastore, ready for manual manipulation or custom dashboards