Use the batch extract activities endpoints to export batched survey responses into a data warehouse.
- Get an
activityId.URL structure
GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activitiesNote: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 Shared responsibility.
-
Optional: Specify
fieldIdparameters in the body.Example POST body
{ "fieldIds": [<GUID of the survey question id>] } - Request a
batchId.URL structure
POST https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/{activityId}/responses/batch - Generate the status and
download link.
URL structure
GET https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/responses/batch/{batchId} - Request activity data from
the download link in the
datafield.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> } - In Locations header, copy the link and paste it into your browser to save your exported file.