/activities/groupings/{groupingUUID}/scenebreakdown

Get a list of statistics about Touchpoint activity scenes by activity grouping_uuid. Returns data about starts/skips/drops/redirects per scene.

Resource URL

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

Available methods

Method	Description
GET	Returns a breakdown of statistics for Touchpoint activity scenes 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}/scenebreakdown?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. position: The order in which the scenes are ordered in the Touchpoint activity builder. 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. starts: starts contains information on the scene starts: is_valid is always true count is the number of starts on the scene skips: skips contains information on the scene skips: is_valid is true if skip metrics can be calculated for the current scene count is the number of skips on the scene drops: drops contains information on the scene drops: is_valid is true if the drop metrics can be calculated for the current scene count is the number of drops on the scene percent is the number of drops divided by the scene views redirects: redirects contains information on the scene redirects: is_valid is true if redirect metrics can be calculated for the current scene count is the number of redirects on the scene percent is the number of redirects divided by the scene views

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": <scene module type>,
              "name": <scene module name>
            }
          ],
          "position": 1,
          "starts": {
            "is_valid": true,
            "count": 6
          },
          "skips": {
            "is_valid": false
          },
          "drops": {
            "is_valid": true,
            "count": 2,
            "percent": 28.57
          },
          "redirects": {
            "is_valid": false
          }
        }
      ]
    }
  ]
}

Parent topic: Touchpoint activities