studies

Export demographic data

Changed on

Create and download a demographic export for a study. This endpoint allows you to export participant demographic data with optional study filter data.

Filter Support: This endpoint supports applying demographic filters to export data for participants who match specific criteria.

When filters are provided, the export includes both base demographic data (age, sex, country, etc.) and the filters.

When no filters are provided, the export includes only base demographic data for all participants who took the study, excluding any study-specific filter responses.

Column keys: By default, each column contributed by filters is keyed by the filter's human-readable title (e.g. Pets). Pass include_filter_id_columns: true to additionally include, for each of those columns, a second column keyed by the filter's stable filter_id (e.g. pets) containing the same value - useful if you want a machine-readable key that won't change if a researcher renames the filter's title. This is opt-in because it doubles the number of filter-derived columns; the title column is never removed or altered. Base demographic columns are unaffected either way.

Export Usage: Please note that you may only select up to 15 filters per export. You are also limited to 2 different filter export requests.

You may download the same request as many times as you need. To check your current usage and see your latest export history, use the Demographic Export History endpoint.

Basic Data Included: The export includes the following data fields:

  • Submission ID
  • Participant ID
  • Submission status
  • Started date-time
    • Expressed in UTC
    • ISO 8601 formatted
  • Completed date-time
    • Expressed in UTC
    • ISO 8601 formatted
  • Time taken (in seconds)
  • Age
  • Sex
    • Participants were asked the following question: What is your sex, as recorded on legal/official documents?
  • Ethnicity (simplified)
  • First language
  • Current country of residence
  • Nationality
  • Country of birth
  • Student status
  • Employment status
  • Reviewed at date-time
    • Expressed in UTC
    • ISO 8601 formatted
  • Completion code ('entered code')
  • Total approvals

Learn more on Exporting Prolific demographic data.

post/api/v1/studies/{id}/demographic-export/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/studies/{id}/demographic-export/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Study ID

Request body

include_filter_id_columnsboolean

When true, each column contributed by filters is additionally included under a second column keyed by the filter's stable filter_id (e.g. pets), alongside the existing column keyed by its human-readable title (e.g. Pets) - both containing the same value. Useful for integrations that want a machine-readable key which won't change if a researcher renames the filter's title.

Opt-in because it doubles the number of filter-derived columns. The title column is never removed or altered, and base demographic columns are unaffected.

Response

Demographic data exported successfully

object required

Changes

    • info

      added the new optional request property ///

    • info

      added the new optional request property //////

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API