/activities/groupings – Alida Help Center

Get a collection of Touchpoint versioned activities.

Resource URL

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

Available methods

Method	Description
GET	Returns a collection of Touchpoint versioned activities.

Parameters

Use the following parameters to control how the data is returned:

Operation	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	`/activities?fields=name,id`
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value.	`/activities/groupings?status=ACTIVITY_PUBLISHED&type=ACTIVITY_NPS`
Paging	By default, 20 items are returned at a time and the maximum is 1000.	Use the limit and offset query string parameters to effectively page through the results.
Sorting	You can sort the response on all of the available items.	`/activities/groupings?sort=created_at:d`

Available Fields

Field	Description
`id`	The ID of the version of the activity.
`activity_version`	The version of the activity.
`grouping_uuid`	The grouping UUID of the activity. This is used to retrieve reporting for activities with multiple versions.
`org_id`	The Touchpoint org that the activity is associated with. This is mapped to the communityApiKeyName.
`name`	The string label for the given activity.
`status`	The string value for the activity status. Standard values include: `ACTIVITY_DRAFT` `ACTIVITY_PUBLISHED`
`created_at`	The timestamp value for the date the activity was created.
`updated_at`	The timestamp value for the date the activity was last changed.
`published_at`	The timestamp value for the date the activity was first distributed.
`uid`	The unique identifier of the activity.
`share_settings`	The share settings of the activity.
`type`	The string value for the activity type. Standard values include: `ACTIVITY_NPS`¹ `ACTIVITY_CUSTOM`
`can_publish`	The boolean value denoting whether the activity can be published in its current state.
`can_preview`	The boolean value denoting whether the activity can be previewed in its current state.
`styles`	The styles of the activity.
`locales`	The locales of the activity.
`default_locale`	The default locale of the activity.

Example: GET request

Get published activities and order by descending created_at date.

https://api.
{region}.alida.com/v2/applications/{applicationName}/touchpoint/activities/groupings?
status=ACTIVITY_PUBLISHED&sort=created_at:d

Example: GET response

{
  "items": [
    {
      "id": <id of the activity version>,
      "org_id": <org id of activity>,
      "name": <activity name>,
      "status": <activity status>,
      "created_at": <date-time (UTC)>,
      "updated_at": <date-time (UTC)>,
      "published_at": <date-time (UTC)>,
      "uid": <unique identifier of activity>,
      "share_settings": <activity share settings>,
      "type": <activity type>,
      "can_publish": <true|false>,
      "styles": <activity styles>,
      "etc": <activity extra attributes>,
      "locales": <activity locales>,
      "default_locale": <activity default locale>,
      "can_preview": <true|false>,
      "activity_version": <activity version>,
      "grouping_uuid": <activity grouping_uuid>
    },
    …
  ],
  "meta": {
    "limit": 20,
    "offset": 0,
    "count": "1"
  },
  "links": [
    {
      "rel": "first",
      "href": "https://api.{region}.alida.com/v2/applications/{applicationName}/touchpoint/activities/groupings?limit=20&offset=0&sort=created_at%3Ad&status=ACTIVITY_PUBLISHED"
    },
    {
      "rel": "last"
    },
    {
      "rel": "prev"
    },
    {
      "rel": "next"
    }
  ]
}

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