/members/{memberId}/activities/{activityId}

Get an instance of an activity a member has been invited to participate in.

Note: Use the Member Groups feature in the application to get a list of member IDs based on a specific criteria. For more information, see Member Groups.

Resource URL

/v1/applications/{communityApiKeyName}/members/{memberId}/activities/{activityId}

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 Shared responsibility.

Available methods

Method	Description
GET	Returns an activity instance for a member.

Available fields

Field

Description

activityIsHidden

The boolean value indicating whether the activity is hidden in the member's activity feed. The default is false.

activityLink

The string value for the activity URL.

activityName

The string value for the name of the activity as it appears in the application.

activityStatus

The string value for the current status of the activity. Standard values include:

• pending
• open
• closed

activityType

The string name for the event type. Standard values include:

• Survey
• Forum
• ExternalActivity
• Sparq1survey

closedOn

The timestamp value of when the activity status changed 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.
• An activity may be re-opened after it has been closed.
• The field is empty if the activity is never closed.

communicationId

The GUID for the communication (if pertinent) for the given event.

This value can be null.

communicationStatus

The string value for the current status of the invitation. Possible values are:

• Pending
• Open
• Closed

communicationType

The string value for a recruitment email or recruitment link. Possible values are:

• Invitation
• Reminder
• Link
• AdhocLink
• ConfirmationReminder

createdBy

The GUID value for the user who created the activity.

createDate

The timestamp value of the date the activity was created.

description

The string text of the email invitation.

eventDate

The timestamp of the actual participation event.

eventType

The type of member event.

Note: Some member event types in Sparq 1 are converted to the Community equivalent when the data is mapped through the bridge. For a complete list of the Sparq 1 events and the corresponding event in Community, see the table in mappedMemberEvents.

For more information about Sparq 1 data, see FAQs.

The following table describes the available event types and the types of activities they are associated with:

Event Type	Description	Surveys	Forums	External Activity
Closed	The activity is closed to participants	X	X	X
Complaint	The member marked the invitation as spam	X	X	X
ConfirmationSent	A confirmation email was sent confirming the member opted into the community Note: Use this event type for recruitment surveys only.	X
DeliveryFailed	The communication failed to be delivered for various reasons	X
ForumInvited	The member was invited to participate in the forum		X	X
ForumJoined	The member joined the forum		X	X
ForumPostCreated	The member posted in the forum		X	X
ForumPostVoted	The member voted for a forum post		X	X
HardBounce	The email delivery failed due to various reasons	X	X	X
PanelJoined	The member joined the community	X
Reminded	An email reminder was sent to the member	X	X	X
SoftBounce	The email delivery failed because of various reasons	X	X	X
Started	The member clicked on the activity link	X	X	X
SurveyCompleted	The member completed the survey activity	X		X
SurveyDisqualified	The member was disqualified from the survey activity	X		X
SurveyInvited	The member was invited to participate in the survey activity	X		X
SurveyOverQuota	The member was directed out of the survey because they were over quota	X		X
SurveyStarted	The member started the survey	X		X
Undeliverable	The member became undeliverable due to 3 hard bounces, or 10 soft bounces	X		X
Unsubscribed	The member asked to be removed from the community	X	X	X

id

The GUID for the given activity.

lastUpdateDate

The timestamp value of the date the activity was last changed.

lastUpdatedBy

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

memberId

The GUID for the member to which this activity applies.

openedOn

The timestamp value of 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.

title

The string text for the email subject line.

Response format

{
  "items": [
    {
      "id": <GUID of activity,
      "memberId": <GUID of member>,
      "activityName": <activity name as seen by members>,
      "activityLink": <https://communityName.com/c/al/communityID>,
      "activityType": <Survey|Forum|ExternalActivity|Sparq1survey>,
      "activityIsHidden": <true|false>,
      "activityStatus": <pending|open|closed>,
      "eventType": <member event type>,
      "eventDate": <date-time (UTC) of when this member event occurred>,
      "title": <subject line in email invitation>,
      "description": <email invitation text>,
      "openedOn": <date-time (UTC) of when this activity was opened>,
      "closedOn": <date-time (UTC) of when this activity closed>,
      "communicationId": <GUID of communication>,
      "communicationStatus": <pending|open|closed>,
      "communicationType": <Invitation|Reminder|Link|AdhocLink|ConfirmationReminder>,
      "createDate": <date-time (UTC) of when this record was created>,
      "lastUpdateDate": <date-time (UTC) of when this record was last updated>,
      "createdBy": <user context who created this record>,
      "lastUpdatedBy": <user context who updated this record>,
      "links": [],
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/members/{memberId}/activities/{activityId}"
    },
  "links": [
    {
      "rel": "first",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/members/{memberId}/activities?offset=0&limit=20"
    },
    {
      "rel": "prev"
    },
    {
      "rel": "last"
    },
    {
      "rel": "next"
    }
  ],
  "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/members/{memberId}/activities"

Parent topic: Member Activities endpoints