DEdefra
Cleanse Export

Get progress and details of a specific export operation

Changed on

Poll this endpoint to track export progress. When the export completes successfully, the response includes reportUrl (a presigned S3 download URL) and reportObjectKey. If the export fails, the error field contains the failure details.

get/cleanse-export/{exportId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/cleanse-export/{exportId}
  • Auth
    API key in header X-API-Key

Path parameters

exportIdstring required

The export operation ID returned from the start endpoint

Response

Export operation details

idstring

Unique export operation identifier.

status'Pending' | 'Running' | 'Completed' | 'Failed'
startedAtUtcstring date-time
completedAtUtcstring date-time nullable
progressPercentagenumber double

Progress percentage (0-100).

statusDescriptionstring

Human-readable status description.

totalRecordsinteger

Total number of records to export.

recordsExportedinteger

Number of records exported so far.

reportObjectKeystring nullable

S3 object key for the generated report. Populated on successful completion.

reportUrlstring nullable

Presigned URL to download the report. Use regenerate-url if expired.

errorstring nullable

Error message with exception details if the export failed.

durationMsinteger nullable

Total duration in milliseconds when complete.

Changes