aiTaskBuilder

Request a Collection Export

Changed on

Initiates an asynchronous export of all participant responses and uploaded files for a collection as a ZIP archive.

The export is generated out-of-band to handle large collections without hitting API timeout limits. The endpoint always returns 202 Accepted with an export_id — use it to poll GET /collections/{collection_id}/export/{export_id} for status.

Each request starts a fresh export job so you can retrieve newly submitted responses matching the same filter, unless one with the exact same filter is already generating, in which case its existing export_id is returned rather than starting a duplicate. A completed or failed export is never reused — sending POST again always starts a new job, giving you a snapshot of responses as of that request. Use GET /collections/{collection_id}/export to see every job you've already requested before starting another. Each collection can have at most 10 export jobs at a time (across all filters combined) — delete one to free up a slot if you hit that limit.

By default the export includes every response. Pass study_id and/or from/to to scope it to a subset — see the query parameters below. Terms combine as AND (e.g. study_id + from/to exports only that study's responses within the date range). Two exports requested with different filters are tracked as separate jobs.

Only researchers with workspace access to the collection can request an export.

post/api/v1/data-collection/collections/{collection_id}/export

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/collections/{collection_id}/export
  • Auth
    API key in header Authorization

Path parameters

collection_idstring required

Query parameters

study_idstring

Only export responses submitted under this Prolific Study ID.

fromstring date-time

Only export responses with created_at on or after this ISO 8601 datetime (inclusive). Accepts an offset (e.g. +01:00) or Z.

tostring date-time

Only export responses with created_at before this ISO 8601 datetime (exclusive). Must not be earlier than from.

Response

Export generation started

status'generating' required
export_idstring uuid required

The export job ID. Use this with GET /collections/{collection_id}/export/{export_id} to poll for status.

Changes

    • breaking

      removed the success response with the status

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter study_id

    • info

      added the new optional query request parameter to

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API