Exports create downloadable files from Syntage data. Use them when your integration needs a file that can be stored, shared, imported into another system, or delivered to an operations team.
Creating an export starts asynchronous processing and returns an Export resource. The export keeps track of the requested source data, output format, processing status, and generated file.
How Exports Work
- Create an export with the collection URI and output format you need.
- Store the returned export ID.
- Retrieve the export until its
status is finished or failed.
- Download the generated file from the File resource referenced by the export.
Exports are useful for workflows such as finance reports, invoice handoffs, customer support investigations, back-office review, and scheduled data delivery.
Report PDF exports
Besides collection exports in csv, xlsx, or json format, exports can also generate a PDF document of an entity report. Set format to pdf and uri to /entities/{entityId}/reports/{reportId}?exporting=true; the finished export references a report.insights.pdf file. The exporting=true query parameter is required and is the only supported query parameter on report URIs. See Reports for the full flow.
For endpoint details, see Exports API Reference.
The export response references a File resource when the generated file is ready. Use the file metadata to inspect the filename, media type, and size before downloading it.
