Common scenarios: Export data for versioned activity with identical scenes

In this example, there is an activity with two versions, but there are scenes in both versions that we want aggregated across versions in the exported data. These scene ids need to be identified in the export request.

1. Get an activity's groupingUUID.

   URL structure

   GET https://api.
   {region}.alida.com/v2/applications/{communityApiKeyName}/touchpoint/activities/groupings

2. Get the activity's scene breakdown for all of its versions using the activity's groupingUUID. In the response, identify the scene_ids of the scenes to aggregate across versions.

   Note: Scenes must have the same question types in order to be aggregated.

   URL structure

   GET https://api.
   {region}.alida.com/v2/applications/{communityApiKeyName}/touchpoint/activities/groupings/{groupingUUID}/scenebreakdown

3. Get an export of a versioned activity's reporting data in CSV or JSON format and specify the identical scene_ids under the identical_scenes field in the request payload. If there are multiple groups of identical scenes, each group is specified in its own scene_ids group.

   URL structure

   POST https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/touchpoint/activities/export

   Note: The request's Content-Type must be set as application/json

Example: POST body

{
    "filters": {
        "start": <YYYY-MM-DDThh:mm:ss.msZ>,
        "end": <YYYY-MM-DDThh:mm:ss.msZ>,
        "versions": [1, 2]
    },
    "identical_scenes": [
        {
            "scene_ids": [
                <scene id>,
                <scene id>
            ]
        }
    ]
}

Parent topic: Using the Touchpoint API