/activities/{id}

Get an instance of a survey or forum.

Resource URL

/v1/applications/{communityApiKeyName}/activities/{id}

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see API Access.

Note: Some activities are not accessible through the API. For a list of available activities, open the Activities page in the application. For more information, see The Activities page.
Tip: To view the member events associated with the activity, click the summary reference link at the end of the response. For more information, see Activity Summary reference.

Available methods

Method Description
GET Returns a single instance of an 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/{id}?fields=name,closedOn

Available Fields

Field Description
accessedOn The timestamp value for the last date the activity was opened in the Activities page of the application.
activityType The string name for the event type. Standard values include:
  • Survey
  • Forum
  • ExternalActivity
  • Sparq1survey
alternateId The ID for an activity in an external system.
Note: Some of activities may be missing from the alternateId in the payload.
closedOn The timestamp value for when the activity status change from open to closed.
Note:
  • This value only applies to activities where the status is either open or closed.
  • This date may occur in the future. An activity may be re-opened after it has been closed.
createDate The timestamp value for the date the activity was created.
createdBy

The GUID value for the user who created the activity.

excludeFromParticipation
The boolean value indicating whether the activity statistics are excluded from the participation metrics:
  • true (default): The activity will not show in participation reports
  • false: The activity will show in participation reports

For more information, see Exclude an activity from community statistics.

hideFromMember The boolean value indicating whether the activity is hidden in the member's activity feed. The default is false.
id The GUID value for the activity's unique identifier.
isReady The boolean value indicating if an activity is ready to be distributed to members.
lastUpdateDate The timestamp value for the date the activity was last changed.
lastUpdatedBy

The GUID value of for the last user who edited the activity.

name The string label for the given activity
openedOn The timestamp value for when the first email invitation or the activity link was set to Open. This value only applies to activities where the status is either open or closed.
Note: This date may occur in the future.
panelId The GUID value for the panel associated with the community.
Note: This is a reserved field.
projectId The GUID value for the parent project of this activity.
projectType The string value of the project type of this activity. Possible values are:
  • Research: A standard activity created from the Projects menu option in the application
  • Recruitment: A system defined activity used for recruiting members that triggers the double opt-in registration workflow
sourceId

The GUID value of an activity that was duplicated.

For example, you duplicate a survey named satisfaction_survey, creating a new survey named satisfaction_survey_copy. The value for sourceId of satisfaction_survey_copy represents the activity named satisfaction_survey.

status
The string value for the activity status as seen in the Distribution page in the application. Possible values are:
  • open
  • closed
statusChangedOn The timestamp value for the date the activity changed from one status to another.
templateUrl The URL used to create an activity based on a template.
Example GET Response
{
   "id": <GUID of activity>,
   "sourceId": <GUID of an activity that was duplicated>,
   "activityType": <type of activity>,
   "name": <activity name>,
   "status": <Open|Closed>,
   "statusChangedOn": <date-time (UTC) of when that activity status changed>,
   "panelId": <GUID of panel>,
   "alternateId": <GUID of activity in an external system>,
   "projectId": <GUID of parent project>,
   "projectType": <Recruitment|Research>,
   "excludeFromParticipation": <true|false>,
   "hideFromMember": <true|false>,
   "isReady": <true|false>,
   "openedOn": <date-time (UTC) of when this activity was opened>,
   "closedOn": <date-time (UTC) of when this activity closed>,
   "accessedOn": <date-time (UTC) of when this activity was last accessed on>,
   "templateUrl": <URL of activity template>,
   "createDate": <date-time (UTC) of when this record was created>,
   "lastUpdateDate": <date-time (UTC) of when this record was last updated>,
   "createdBy": <user context that created this record>,
   "lastUpdatedBy": <user context that last updated this record>
   "links": [
      {
         "rel": "summary",
         "href": "https://api.{region}.alida.com/c/services/api/v1/tenants/{panelId}/activities/{id}/summary"
      }
   ],
   "href": "https://api.{region}.alida.com/c/services/api/v1/tenants/{panelId}/activities/{id}"
}

Activity Summary reference

The links section at the end of the /activities/{id} response contains the summary reference link. Click the link to see a summary of the member events for this activity. For more information, see Member Events.

Example: Summary link
{
   ...
   "links": [
      {
         "rel": "summary",
         "href": "https://api.{region}.alida.com/c/services/api/v1/tenants/{panelId}/activities/{id}/summary"
      },
   ...
}
Example: Summary result
{
   "distributionStatus": <Pending|Open|Closed>,
   "memberEvents": {
      "surveyInvited": <count>,
      "surveyCompleted": <count>,
      ...
   },
   "createDate": <date-time (UTC) of when this record was created>,
   "lastUpdateDate": <date-time (UTC) of when this record was last updated>,
   "createdBy": <user context that created this record>,
   "lastUpdatedBy": <user context that last updated this record>,
   "links": [],
   "href": "https://api.{region}.alida.com/c/services/api/v1/tenants/{panelId}/activities/{id}/summary"
}