/memberevents – Alida Help Center

Resource URL

/v1/applications/{communityApiKeyName}/memberevents

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 collection of member events.

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.	`/memberevents?fields=activityId,eventType`
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value. You can filter the response on the values in the following fields: `activityId` `communicationId` `communityId` `createDate` `createdBy` `eventDate` `lastUpdatedBy` `memberDataSetType` `memberId` `participantType`	`q=lastUpdateDate="2016-11-15T01:01:28.4112016Z"`
Paging	The default is 20 items are returned at a time.	Use the `limit` and `offset` query string parameters to effectively page through the results.
Sorting	You can sort the response on the following fields: `activityId` `communicationId` `communityId` `createDate` `createdBy` `eventDate` `lastUpdateDate` `lastUpdatedBy` (default) `memberDataSetType` `participantType`	`/memberevents?sort=createDate:d`

For more information, see Content control.

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.

Code samples

Get the number of completed member events for an activity

GET
			 /memberevents?eventType=SurveyCompleted&activityId={id}

Get all invited member events for a member

GET
			 /memberevents?eventType=SurveyInvited&memberId={id}

Example: GET response

The following example shows the member event response for Community.

If the request included Sparq 1 Member Events the value eventType would show the Sparq 1 event type (Incomplete and completed), and mappedEventType would show the corresponding value in Community (SurveyStarted and SurveyCompleted).


{
   "meta": {
      "offset": 0,
      "limit": 2,
      "count": 77
   },
   "items": [
      {
         "id": <GUID of member event>,
         "activityId": <GUID of activity>,
         "communicationId": <GUID of communication>,
         "memberId": <type of member event>,
         "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>,
         "lastUpdateDate": <date-time (UTC) of when this record got last updated>,
         "createdBy": <user context that created this record,
         "lastUpdatedBy": <user context that last updated this record>,
         "links": [],
         "href": ".../memberevents/memberEventsId"
      },
      {
         "id": <GUID of member event>,
         "activityId": <GUID of activity>,
         "communicationId": <GUID of communication>,
         "memberId": <type of member event>,
         "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>,
         "lastUpdateDate": <date-time (UTC) of when this record got last updated>,
         "createdBy": <user context that created this record,
         "lastUpdatedBy": <user context that last updated this record>,
         "links": [],
         "href": ".../memberevents/memberEventsId"
      }
   ],
   ...
}