/activities/export

Get an export of a versioned activity's reporting data in CSV or JSON format.

Resource URL

/v2/applications/{communityApiKeyName}/touchpoint/activities/export

Available methods

Method	Description
POST	Returns a response with the reporting data of a versioned activity, including Version, Distribution Name, Status, ActivityStart, ActivityCompleted, Source, Device Type, Browser, Response Locale, and Scene Responses. Scene Responses are individual columns named <Screen Name>_<Screen Text>.

Parameters

Note:

• The request's Content-Type must be set as application/json
• Set the Accept header to application/json to return a response in JSON format. Otherwise, the response returned will be in CSV format.

Parameter	Description
filters	The exported data is filterable by: start: Exported data occurred on or after the specified time. Timestamps must be in ISO 8601. end: Exported data occurred on or before the specified time. Timestamps must be in ISO 8601. versions: The versions of the activity to export.
identical_scenes	If there are different scenes across versions of the activity that you would like to consolidate for the reporting, they can be specified in groups of scene_ids. scene_ids for the different versions of the activity can be retrieved from the /activities/groupings/{groupingUUID}/scenebreakdown endpoint.

Example: POST body

{
    "grouping_uuid": <activity grouping_uuid>,
    "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>
            ]
        }
    ]
}

Example: GET Response

Sample CSV headers

Activity Version | Distribution Name | Status | Targeting Rules Set | ActivityStart | ActivityCompleted |
 Source | Device Type | Browser | Response Locale | Member ID | Version 1: Text Entry | Version 1: Sentiment 
| Version 2: Text Question_Text Response 1 | Version 2: Text Question_Text Response 2

Parent topic: Touchpoint activities