Export survey responses into a data warehouse

Use the batch extract activities endpoints to export batched survey responses into a data warehouse.

Note: These scenarios apply to Extract Activities only.
  1. Get an activityId.
    URL structure

    GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities

    Note:

    Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see API Access.

  2. Optional: Specify fieldId parameters in the body.
    Example POST body
    {
    "fieldIds": [<GUID of the survey question id>]
}
  3. Request a batchId.
    URL structure

    POST https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/{activityId}/responses/batch

  4. Generate the status and download link.
    URL structure

    GET https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/responses/batch/{batchId}

  5. Request activity data from the download link in the data field.
    URL structure

    GET https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/responses/files/{fileId}

    Response structure
    {
    "id": <GUID of the batch>,
    "datasetId": <GUID of the dataset (activity)>,
    "status": <pending|executing|succeeded|failed>,
    "message": <any error messages>,
    "createDate": <date-time (UTC) of when this record got created>,
    "createdBy": <user context that created this record>,
    "lastUpdateDate": <date-time (UTC) of when this record got last updated>,
    "lastUpdatedBy": <user context that last updated this record>,
    "data": <link to the batch export>
}
  6. In Locations header, copy the link and paste it into your browser to save your exported file.