Batch Data Extract

Batch Data Extract resources can export activity or member profile data and return a download link to quickly move data out from Community.

Retrieve data from either:

• Activity data from Community surveys and power surveys only. This excludes Highlighter, Click Map, Media Player or Image Upload questions.
• Member profile data from active members.

Find out more about the process of exporting either activity or member profile data:

Option	Description
Activity data	To export your activity data, you will need to: POST to request a batchId. Note: You can select specific parameters in your POST call. GET to generate the download link. GET to retrieve the activity data and download link. In the Locations header, copy and paste the link into your browser to save your exported file. For more information, see /data/activities/{activityId}/responses/batch and /data/activities/responses/batch/{batchId}.
Member profile	To export your member profile data, you will need to: POST to request a batchId. Note: You can select specific parameters in your POST call. GET to generate the download link. GET to retrieve the member profile data and download link. In the Locations header, copy and paste the link into your browser to save your exported file. For more information, see /data/members/profiles/batch and /data/members/profiles/batch/{batchId}.

Before you begin using batch data extract resources, you should familiarize yourself with the following terms as they relate to this API:

Fields

A field defines a place to store a single value. Think of a field as a variable. A field declares the type of data that it accepts. For example, a field might only store numbers, or strings, or dates. For a survey, a field is usually the place to store a value for a specific question, or another piece of data.

Fields example

A survey contains the following Single Choice question:

What is your gender?

• Male
• Female

In your batch activity extract, this field (question) would look like this:

{
    "id": <GUID of the batchId>,
    "datasetId": <GUID of the activityId>,
    "definition": {
        "fields": [
            {
                "id": <GUID of the questionId>,
                "name": <What is your gender?>,
                "meta": {
                    "visibility": <active>
                },
                "type": {
                    "dataType": <set>,
                    "values": [
                        {
                            "id": <GUID of the Male>,
                            "name": <Male>,
                            "meta": {
                                "visibility": <active>}
                          	{
                            "id": <GUID of the Female>,
                            "name": <Female>,
                            "meta": {
                                "visibility": <active>}
                        }
                    ]
                }
            },
        ]
    },

Records

A record is a collection of values for the fields in an batch activity extract. For a survey, a record corresponds to all of the data produced when a participant takes the entire survey one time.

Example record

			
 {   "records": [
        {
            "ownerId": <GUID of the member>,
            "fields": [
                {
                    "id": <GUID of the questionId>,
                    "values": [
                        <GUID of the question option. Can be string|double|datetime>
                    ]
                },
            ]
        }
    ]
}

Data type

A data type defines what kinds of values may be assigned to a column. All datasets support a standard set of primitive data types, such as string, double, date-time, identifier, enum and set.

For more information, see Data types.