/activities/{activityID}/scenebreakdown (DEPRECATED)

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

Resource URL

/v2/applications/{communityApiKeyName}/touchpoint/activities/{activityID}/scenebreakdown

Available methods

Method	Description
GET	Returns a breakdown of statistics for Touchpoint activity scenes.

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/{activityID}/scenebreakdown?fields=name,starts

Available Fields

Field	Description
id	The ID of the scene.
name	The string label for the scene.
template_type	The template type of the scene. Possible values include: GENERIC_01 QUESTION_TEXT_ENTRY QUESTION_FLEXIBLE QUESTION_DATE_ENTRY CTA_01 (CTA Link) CTA_02 (CTA Email) NUMERIC_NPS℠ 1 NUMERIC_RANGE
position	The order in which the scenes are ordered in the Touchpoint activity builder.
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

{
  "scenes": [
    {
      "id": <scene id>,
      "name": <scene name>,
      "template_type": <scene template type>,
      "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
      }
    },
    {
      "id": <scene id>,
      "name": <scene name>,
      "template_type": "<scene template type>,
      "position": 2,
      "starts": {
        "is_valid": true,
        "count": 5
      },
      "skips": {
        "is_valid": false
      },
      "drops": {
        "is_valid": true,
        "count": 5,
        "percent": 100
      },
      "redirects": {
        "is_valid": true,
        "count": 0,
        "percent": 0
      }
    }
  ]
}

¹ Net Promoter, NPS, and the NPS-related emoticons are registered U.S. trademarks, and Net Promoter Score and Net Promoter System are service marks, of Bain & Company, Inc., NICE Systems, Inc. and Fred Reichheld.