/activities/{activityID}/responsebreakdown (DEPRECATED)

Get data about responses to various Touchpoint activity screens.

Resource URL

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

Available methods

Method	Description
GET	Returns a list of a Touchpoint activity's response breakdown.

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}/responsebreakdown?fields=name,title

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
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
title	The title of the scene.

Example: GET response

{
  "scenes": [
    {
      "id": <scene id>,
      "name": <scene name>,
      "template_type": <scene template type>,
      "data": {
        "total": 0,
        "selections": [
          {
            "id": <selection id>,
            "count": 0,
            "percent": 0,
            "text": <selection text>
          },
          {
            "id": <selection id>,
            "count": 0,
            "percent": 0,
            "text": <selection text>
          }
        ]
      },
      "title": <scene title>
    },
    {
      "id": <scene id>,
      "name": <scene name>,
      "template_type": <scene template type>,
      "data": {
        "total": 1,
        "sentiment": {
          "sentiment_score": {
            "positive": 0.82,
            "negative": 24.79,
            "mixed": 65.16,
            "neutral": 9.23
          },
          "sentiment_result": <sentiment result type>
        }
      },
      "title": "Title"
    }
  ]
}

¹ 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.