Get Collection Export Status

Polls the status of an asynchronous collection export job initiated by POST /collections/{collection_id}/export.

Returns the current status of the export:

generating — the export is still being built; continue polling.
complete — the export is ready; a presigned HTTPS download URL is included. URLs are valid for 1 hour and are automatically refreshed if expired.
failed — generation failed (e.g. the archive was deleted from storage). Re-send POST /collections/{collection_id}/export to retry.

Polls the status of an asynchronous collection export job initiated by `POST /collections/{collection_id}/export`. Returns the current status of the export: - **generating** — the export is still being built; continue polling. - **complete** — the export is ready; a presigned HTTPS download URL is included. URLs are valid for 1 hour and are automatically refreshed if expired. - **failed** — generation failed (e.g. the archive was deleted from storage). Re-send `POST /collections/{collection_id}/export` to retry.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Path parameters

collection_idstringRequired

export_idstringRequired

Response

Export status

object

An export job that has been enqueued and is currently being generated.

object

An export job that has completed successfully. The ZIP archive is ready to download.

object

An export job that failed to generate, or whose archive has since been deleted. Re-send POST /collections/{collection_id}/export to retry.

Errors

404

Not Found Error