/activities/groupings/{groupingUUID}/responsebreakdown

Get data about responses to various Touchpoint activity scenes.

Resource URL

/v2/applications/{communityApiKeyName}/touchpoint/activities/groupings/{groupingUUID}/responsebreakdown

Available methods

Method	Description
GET	Returns a list of a Touchpoint activity's response breakdown for all versions of the activity.

Parameters

Use the following parameters to control how data is returned:

Parameter	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	/activities/groupings/{groupingUUID}/responsebreakdown?fields=activity_version,scenes

Available Fields

Field	Description
activity_name	The name of the activity.
activity_id	The ID of the activity version.
grouping_uuid	The grouping UUID of the activity.
activity_version	The version of the activity.
scenes	The scene field contains the following child fields: id: The ID of the scene. name: The string label for the scene. scene_modules: The scene module field contains the following child fields: id: The ID of the scene module. name: The name of the scene module. module_type: The type of the scene module. data: Data contains information on response breakdown: total: total number of responses for the scene selections: metrics on selections in the scene. Each selection contains: id (selection ID) count percent text image_url (only returned if image set) Image_alt_text (only returned if image set) sentiment: sentiment scores and sentiment_result for text entry scenes sentiment_result is one of: SENTIMENT_POSITIVE SENTIMENT_NEGATIVE SENTIMENT_MIXED SENTIMENT_NEUTRAL

Example: GET response

{
  "activities": [
    {
      "activity_name": <activity name>,
      "activity_id": <id of activity version>,
      "grouping_uuid": <activity grouping_uuid>,
      "activity_version": <activity version>,
      "scenes": [
        {
          "id": <scene id>,
          "name": <scene name>,
          "scene_modules": [
            {
              "id": <scene module id>,
              "module_type": "MODULE_CHOICE_QUESTION",
              "data": {
                "total": 3,
                "selections": [
                  {
                    "id": <selection id>,
                    "count": 1,
                    "percent": 33.33,
                    "text": "Text Response"
                  },
                  {
                    "id": <selection id>,
                    "count": 2,
                    "percent": 66.67,
                    "text": "Text Response"
                  }
                ]
              },
              "name": "Text Question"
            }
          ]
        }
      ]
    }
  ]
}

Parent topic: Touchpoint activities