/data/activities/{activityId}/responses/batch

Initiate an export of fields, field groups, and response records from a selected activity.

Prerequisite

Resource URL

https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/activities/{activityId}/responses/batch
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.

Available methods

Method Description
POST Initiate an export of activity definitions and responses. A batchId is returned.

Parameters

If you want to select specific survey questions to export, create a POST survey questions id(s).

Note: The request body data is always parsed as JSON.
Parameter Description
fieldIds An optional parameter to specify a set of field (survey question) or field group GUIDs to return.
Note: If only the fieldId of the CompletedDate system variable is specified, no response records are returned.
sinceDatetime The optional sinceDatetime parameter is used to return all new or updated responses that occurred on or after the specified date-time value. Date-time values must follow the ISO 8601 UTC format.
untilDatetime The optional untilDatetime parameter is used to return all new or updated responses that occurred before the specified date-time value. Date-time values must follow the ISO 8601 UTC format.
Example POST body
{
    "fieldIds": [<GUID of survey question ID 1>, <GUID of survey question ID 2>,...],	
    "sinceDatetime": <YYYY-MM-DDThh:mm:ss.msZ>,
    "untilDatetime": <YYYY-MM-DDThh:mm:ss.msZ>
}

Available fields

Element Description
id GUID of the batchId.
Example
{
    "id": <GUID of the batchId>
}