/activities/groupings/{groupingUUID}/distresults

Get a list of distribution-level metrics for all versions of a Touchpoint activity.

Resource URL

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

Available methods

Method	Description
GET	Returns a list of distribution results 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/{activityID}/distresults?fields=name,status

Available Fields

Field	Description
name	The string label for the distribution.
dist_id	The ID of the distribution.
status	The string value for the distribution status. Standard values include: DIST_ACTIVE DIST_INACTIVE
type	The string value for the distribution type. Standard values include: DIST_HUB DIST_SOCIAL_MEDIA DIST_SDK_URL_PATH DIST_SDK_SITUATIONAL DIST_MOBILE
created_at	The timestamp value for the date the distribution was created.
events	Events contain data about specific activity events for the distribution. Each event is keyed on the event type and contains: count percent

Example: GET response

{
  "dist_results": [
    {
      "name": <distribution name>,
      "dist_id": <distribution id>,
      "status": <distribution status>,
      "type": <distribution type>,
      "created_at": <date-time (UTC)>,
      "events": {
        "ACTIVITY_FINISH": {
          "count": 1,
          "percent": 100
        },
        "ACTIVITY_RENDER": {
          "count": 5,
          "percent": 100
        },
        "ACTIVITY_START": {
          "count": 1,
          "percent": 20
        }
      }
    },
    {
      "name": <distribution name>",
      "dist_id": <distribution id>,
      "status": <distribution status>,
      "type": <distribution type>,
      "created_at": <date-time (UTC)>,
      "events": {
        "ACTIVITY_FINISH": {
          "count": 0,
          "percent": 0
        },
        "ACTIVITY_RENDER": {
          "count": 0,
          "percent": 0
        },
        "ACTIVITY_START": {
          "count": 0,
          "percent": 0
        }
      }
    }
  ]
}

Parent topic: Touchpoint activities