/data/members/profiles/batch/{batchId}

Get the status and download link of your batch member profile export.

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.

Prerequisite

Steps

Retrieve member data from your download link by following these steps:

  1. Make a GET call to obtain the download link:

    https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/members/profiles/batch/{batchId}

  2. Make a GET call to retrieve member data from the download link in the data field:

    https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/members/profiles/files/{fileId}

  3. In the Locations header, use the link to download the export file. Skip this step if the download link is automatically redirected to download the export file.
    Note: Streaming is a recommended method to extract large quantities of data without affecting memory or performance. Use any HTTP client capable of streaming and is compatible with the language you are using.

Resource URL

  1. /v2/applications/{communityApiKeyName}/data/members/profiles/batch/{batchId}
  2. /v2/applications/{communityApiKeyName}/data/members/profiles/files/{fileId}

Available methods

Method Description
1. GET Get the status and download link of the batch member data export.
2. GET Get the batched member data from the download link.

Available fields for 1. GET

Element Description
createDate The date and time in UTC when the export was created.
createdBy The string GUID of the user who created the batch member data export.
data The download link to the batch member data export.
errorMessage The string value of the error message.
id The string GUID of the batchId.
lastUpdateDate The date and time in UTC when the export was last updated.
lastUpdatedBy The string GUID of the user who last updated the Member Profile.
message

This element contains a field called artifact. The artifact field gets appended to the end of the data element, otherwise known as fileId.

status The string value of the current status of the export. Possible values are:
  • Pending
  • Running
  • Succeeded
  • Failed
Example
{
    "id": <GUID of the batch>,
    "status": <pending|running|succeeded|failed>,
    "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>,
    "message": {
         "artifact": <fileId of the batch export>},
    "errorMessage": <string value of the error message>,
    "data": <link to the batch export>
}

Available fields from the JSON file

Table 1. Top-level elements
Element Description
id

GUID of the batchId.

exportDate The date and time when the export was started.
exportOptions Export parameters specified. Possible values are:
  • sinceDatetime: The date and time specified. Exports will show member profile data updated after the date and time specified.
members Member records in the dataset. A record contains all the data produced when a member takes a survey.
lastSyncDate The date and time when member profile values were last synced.
Note: It is recommended to use the value from this element as the sinceDatetime in the next export.
Table 2. Elements under the members attribute
Element Description
memberId GUID of the memberId of a member.
variables Top level attribute of individual Member Profile for the respective memberId.
Table 3. Elements under the variables attribute
Element Description
dataType The value of how the Member Profile Values are stored. Possible values are:
  • string: The value is stored as text.
  • double: The value is stored as numeric.
  • datetime: The value is stored as date-time.
  • identifier: The value is stored as a text identifier.
  • enum: Allows the choice of a single value from a list of possible values.
  • set: Allows the choice of multiple values from a list of possible values.
effectiveDate

This element represents the immediate date and time when the Member Profile was created. The date-time is stored as UTC.

id The string GUID of the memberProfileName.
isSensitive A boolean value indicating whether the Member Profile contains sensitive data:
  • true
  • false
name The string of the memberProfileName.
values The values of the Member Profile.
  • id: The GUID of the Member Profile Values. The value is the memberProfileValueId.
    Note: id is not applicable to Open End questions.
  • value: Responses to the respective member profile variable. Possible values are:
    • string: For text open-ends.
    • double: For numeric open-ends.
    • datetime: For date-time open-ends.
Note: The response payload can differ from the example if you specified parameters in /data/members/profiles/batch.
Example
{
    "id": <GUID of the batchId>,
    "exportOptions": {		
         "sinceDatetime": <date-time specified by the user>
    },
    "exportDate": <date-time when the export started>,
    "lastSyncDate": <date-time when the latest member profile values were last synced>,
    "members": [ <member records>
        {
            "memberId": <GUID of the memberId>
            "variables": [
                {
                    "id": <string GUID of the memberProfileName>
                    "name": <string name of the memberProfileName>
                    "dataType": <string|double|datetime|identifier|enum|set>,
                    "isSensitive": <true|false>
                    "values": [
                        {
                            "value": <string|double|datetime>
                            "id": <GUID of the memberProfileValuesId>
                        }
                    ],
                    "effectiveDate": <date-time (UTC) when the member profile variable became effective>
                },
            ]
        },
    ]
}