/activities/groupings/{groupingUUID}/overallmetrics

Get a Touchpoint activity's metrics, including total responses, days in field, quota progress, and responses per day for all versions of the activity.

Resource URL

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

Available methods

Method	Description
GET	Returns an instance of a Touchpoint activity's overall metrics 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}/overallmetrics?fields=name,total

Available Fields

Field	Description
name	The string label for the given activity.
total	Total views.
start	The timestamp value for the first day the activity collected data.
end	The timestamp value of the current time, or if there are no active distributions, the last distribution updated_at date.
data	Data contains information on views per day breakdown: label_ts: unix epoch timestamp count: number of views
cards	Cards contain data about specific activity events. Each card is keyed on the event type and contains: count percent
quota_progress	The sum of all quotas across all the distributions in the activity. Contains: count total percent
days_in_field	The number of days elapsed since the first activity view.
completes_per_day	Total completes divided by days in field.
purged_at	The timestamp value for the last time the activity's sensitive data was purged.

Example: GET response

{
  "name": <activity_name>,
  "total": 1,
  "start": <date-time (UTC)>,
  "end": <date-time (UTC)>,
  "data": [
    {
      "label_ts": <unix timestamp>,
      "count": 1
    },
   …
  ],
  "cards": {
    "ACTIVITY_FINISH": {
      "count": 1,
      "percent": 100
    },
    "ACTIVITY_RENDER": {
      "count": 1,
      "percent": 100
    },
    "ACTIVITY_START": {
      "count": 1,
      "percent": 100
    }
  },
  "quota_progress": {
    "count": 1,
    "total": 10,
    "percent": 10
  },
  "days_in_field": 1,
  "completes_per_day": 1
}

Parent topic: Touchpoint activities