/memberevents/{id}

Returns a single instance of a member event.

Resource URL

/v1/applications/{communityApiKeyName}/memberevents/{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 Shared responsibility.

Available methods

Method	Description
GET	Returns a single instance of a member event

Parameters

Use the following parameters to control how data is returned:

Operation	Description	Example
Filtering by field	You can filter the response on the items that match your criteria.	memberevents/{id}?fields=activityId,eventType

Available fields

Field

Description

activityId

The GUID for the activity to which this event applies.

communicationId

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

This value can be null.

communityId

This field has been deprecated. Do not use this field.

createDate

The timestamp of when the record was inserted into the Community database.

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 member event.

mappedMemberEvent

The name of the Sparq 1 event type after it is mapped into Community.

Note: If your response contains Sparq 1 data, you may see two different event types:

• The eventType value is the name of the event in Sparq 1.
• The mappedMemberEvent value is the corresponding name in Community.

The following table shows the Sparq 1 event type and the corresponding event type in Community:

Community	Mapped Member Event
Invited	SurveyInvited
Started	Started
Incomplete	SurveyStarted
Completed	SurveyCompleted
OverQuota	SurveyOverQuota
Disqualified	SurveyDisqualified
Complaint	Complaint
SoftBounce	SoftBounce
HardBounce	HardBounce
Undeliverable	Undeliverable
Unsubscribed	Unsubscribed

memberDataSetType

Returns either live or test event values. The default value is live.

memberId

The GUID for the member to which this event applies (required).

participantType

The string value for the member's status at the time the event occurred.

Possible values are:

• Member: The participant is an active member of the community.
• NonMember: The participant has a real email.
• Anonymous: The participant has no email.
• Recruit: This field has been deprecated.

GET response format

{
   "id": <GUID of member event>,
   "activityId": <GUID of activity>,
   "communicationId": <GUID of communication>,
   "memberId": <GUID of member>,
   "eventType": <type of member event>,
   "participantType": <Member|NonMember|Anonymous|Recruit>,
   "mappedEventType": <type of member event (specific to Community)>,
   "eventDate": <date-time (UTC) of when this member event occurred>,
   "memberDataSetType": <Live|Test>,
   "createDate" : <date-time (UTC) of when this record got created>,
   "createdBy" : <user context that created this record>,
   "lastUpdateDate" : <date-time (UTC) of when this record got last updated>,
   "lastUpdatedBy" : <user context that last updated this record>
}

Parent topic: Member Events endpoints