Objects
Campaign
Campaign
The Campaign
Object contains detailed information about a LoyaltySurf campaign.
Attributes | ||
id |
| The unique identifier of the campaign |
name |
| The campaign name |
loyaltyActionCount |
| The total loyalty action count |
participantCount |
| The total participant count |
winnerCount |
| The total number of winners†† |
status |
| The campaign status: |
rewards |
| The list of Rewards associated with the campaign |
†† Winners = all participants with at least one approved reward.
Reward
Reward
The Reward
Object contains detailed reward information about a single reward for a campaign.
Note: This Reward
Object is different from a ParticipantReward
Object, which is a reward earned by a participant.
Attributes | ||
id |
| The unique identifier of the reward |
description |
| A description of the reward |
subdescription |
| A sub-description of the reward |
instructions |
| Instructions for the participant to unlock the reward (in HTML format) |
cta |
| The call-to-action (CTA) for the reward |
submissionType |
| The type of reward submission the participant must complete.
Options: |
submissionExampleUrl |
| Only applicable if |
submissionFormUrl |
| Only applicable if |
submissionFormFields |
| Only applicable if |
submissionFormButtonText |
| The text for the form submission button. |
submissionFormMessages |
| Only applicable if |
isUnlimited |
|
|
limit |
| The number of times a participant can earn this reward (this property is overridden with |
conversionsRequired |
| The number of loyalty actions a participant must complete to earn this reward |
imageUrl |
| The reward image URL |
metadata |
| The reward metadata |
Participant
Participant
The Participant
Object contains detailed information about a campaign participant.
Attributes | ||
id |
| The unique identifier of the participant |
firstName |
| The first name of the participant |
lastName |
| The last name of the participant |
loyaltyActionCount |
| The total number of loyalty actions made by the participant |
monthlyLoyaltyActionCount |
| The total number of loyalty actions made this month by the participant (resets at the end of the month) |
prevMonthlyLoyaltyActionCount |
| The total number of loyalty actions made the previous month by the participant. |
| The email of the participant | |
createdAt |
| The date the participant was added to the campaign (UTC milliseconds) |
fraudRiskLevel |
| A value that represents the integrity of the participant: |
fraudReasonCode |
| A value representing the reason for the |
isWinner |
|
|
loyaltyActionCountsPerReward |
| A breakdown of how many loyalty actions overall was performed by the participant per reward. It's an object with the campaign reward ID as the key, and the number of loyalty actions performed as the value. This key will not exist if the participant has not performed any loyalty actions, instead of being an empty object |
monthlyLoyaltyActionCountsPerReward |
| A breakdown of how many loyalty actions for the current month was performed by the participant per reward. It has the same shape as |
loyaltyActionSource |
| The source of how the participant joined the campaign: |
rewards |
| A list of |
notes |
| A value containing internal notes about the participant, added via the LoyaltySurf Dashboard |
metadata |
| An Object containing any custom key-value data, useful when you want to save additional data for the participant (e.g, Metadata is never used by LoyaltySurf and usage is optional. Metadata is returned in REST API calls. For more information, please see API Guidelines. |
rank |
| The rank of the participant. |
monthlyRank |
| The monthly rank of the participant. This rank resets to 0 at the end of each month. |
prevMonthlyRank |
| The previous monthly rank of the participant. This rank will not be be returned if the participant did not exist within your campaign during the previous month. |
ParticipantReward
ParticipantReward
The ParticipantReward
Object represents a reward that the participant has earned.
Note: This ParticipantReward
Object is different from a Reward
Object and contains information that is only pertinent to the participant that earned the reward.
Attributes | ||
id |
| The unique identifier of the participant's reward |
rewardId |
| The ID of the |
status |
| The status of the reward: |
isAvailable |
|
|
approved |
|
|
approvedAt |
| The date and time the reward was approved for this participant (UTC milliseconds). It is |
isFulfilled |
|
|
fulfilledAt |
| The date and time the reward was fulfilled for this participant (UTC milliseconds). It is |
unread |
| |
ParticipantRewardFormSubmission
ParticipantRewardFormSubmission
The ParticipantRewardFormSubmission
Object represents a reward form submission that the participant has filled out and sent from the advocate portal.
Note: This ParticipantRewardFormSubmission
Object does not mean the participant has earned any rewards yet. You will need to approve their submission or trigger the loyalty action in order for the reward to be unlocked for them.
Attributes | ||
id |
| The unique identifier of the reward form submission |
participantId |
| The unique identifier of the |
participantEmail |
| The email address of the |
rewardId |
| The ID of the |
status |
| The status of the reward: |
formData |
| An Object containing the form submission details. The key-value data corresponds with the fields in |
Last updated