| Table of Contents |
|---|
Offers
Offers Page
...
Event |
|---|
Properties
Note
Status
Page View
Name |
|---|
OffersPath: /rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Button
Name:
AccountPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Button
Name:
RewardsPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Link
Name:
Choose Your LocationPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Tab
Name:
All OffersPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Tab
Name:
External OffersPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Tab
Name:
FavoritesPath:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
Button
Name:
Have a Promo Code?Path:
/rewards/offers
| Status | ||||
|---|---|---|---|---|
|
List Item
Name:
Offer NameEngine ID:
Offer Engine IDSanity ID:
Offer Sanity IDService Mode:
pickup,deliveryPath:
/rewards/offers
Type:
All Offer,External Offer,Favorited Offers
Event is triggered when user clicks
| Status | ||||
|---|---|---|---|---|
|
Offer Detail Page
...
...
Event
...
Properties
...
Note
...
Page View
...
Name:
Offer DetailPath:
/rewards/offers/offerID
...
offerIDOffer link
Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d
...
Button
...
Name:
AccountPath:
/rewards/offers/offerID
...
Button
...
Name:
RewardsPath:
/rewards/offers/offerID
...
Link
...
Name:
Choose Your LocationPath:
/rewards/offers/offerID
...
Button
...
Name:
FavoritePath:
/rewards/offers/offerID
...
Button
...
Name:
Mobile OrderPath:
/rewards/offers/offerID
...
Button
...
Name:
Redeem In-StorePath:
/rewards/offers/offerID
External Offer Detail Page
...
...
Event
...
Properties
...
Note
...
Page View
...
Name:
External Offer DetailPath:
/rewards/offers/offerID
...
offerIDExternal Offer link
Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d
...
Button
...
Name:
BackPath:
/rewards/offers/offerID
...
Button
...
Name:
FavoritePath:
/rewards/offers/offerID
...
Button
...
Name:
Mobile OrderPath:
/rewards/offers/offerID
...
The label button changes depending on the external offer partner.
...
Button
...
Name:
Terms and ConditionsPath:
/rewards/offers/offerID
External Offer Modal
...
...
Event
...
Properties
...
Note
...
Modal
...
Name:
Access External OfferPath:
/rewards/offers/offerID
...
offerIDExternal Offer link
Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d
...
Button
...
Name:
YesPath:
/rewards/offers/offerID
...
Button
...
Name:
Not NowPath:
/rewards/offers/offerID
...
Event Name
...
Description
...
Properties
...
Property Description
...
Offer Selected
...
User clicked on an offer from the offers list and saw the offer description.
Replaces the deprecated Offer click event.
...
name
...
Offer name, e.g. “£4.99 CHICKEN or VEGAN ROYAL”
...
sanityId
...
Sanity ID of the offer
...
Offer Added to Order
...
User added a reward to their order cart. When redemptionMode is In-Store, this event is triggered when the user clicks on the “Use at restaurant“ button.
Replaces the deprecated Restaurant Offer selected event.
...
Same as Offer Selected
...
Same as Offer Selected
...
redemptionMode
...
Can be either In-Store or Online.
...
Offer Favorite Added
...
User clicked on the heart to favourite an offer.
...
Same as Offer Selected
...
Same as Offer Selected
...
storeId
...
ID of the currently selected store, if any.
...
Offer Favorite Removed
...
User clicked on the heart to un-favourite an offer.
...
Same as Offer Selected
...
Same as Offer Favorite Added
Rewards
Default Program
Rewards Page
...
...
Event
...
Properties
...
Page View
...
Name:
RewardsPath:
/rewards
...
Button
...
Name:
AccountPath:
/rewards
...
Button
...
Name:
RewardsPath:
/rewards
...
Card
...
Name:
RewardPath:
/rewardsType:
Reward ID
Reward Detail Page
...
...
Page View
...
Name:
Reward DetailPath:
/rewards/detail
...
Button
...
Name:
BackPath:
/rewards/detail
...
Button
...
Name:
Add to Mobile OrderPath:
/rewards/detail
...
Button
...
Name:
Redeem In RestaurantPath:
/rewards/detail
Loyalty Tiers Program
Rewards Page
...
...
Page View
...
Name:
RewardsPath:
/rewardsUser propriety:
Tier 1,Tier 2
...
Button
...
Name:
AccountPath:
/rewards
...
Button
...
Name:
How it WorksPath:
/rewards
...
Card
...
Name:
RewardPath:
/rewardsType:
Reward ID
Unlocked Loyalty Tiers Reward
...
...
Page View
...
Name:
Reward DetailPath:
/rewards/detail
...
Button
...
Name:
BackPath:
/rewards/detail
...
Button
...
Name:
Add to Mobile OrderPath:
/rewards/detail
...
Button
...
Name:
Redeem In RestaurantPath:
/rewards/detail
Locked Loyalty Tiers Reward
...
Page View
Name:
Reward DetailPath:
/rewards/detail
Button
Name:
BackPath:
/rewards/detail
Button
Name:
Order More to become a SuperkingPath:
/rewards/detail
Event Name
Description
Properties
Property Description
Reward Selected
User clicked on the reward from reward list and saw the reward description.
name
Reward name, e.g. “Bacon Double XL Cheese Meal“
sanityId
Sanity ID of the offer
Reward Added to Order
User added a reward to their order cart.
Same as Reward Selected
Description | Properties | Property Description | |
|---|---|---|---|
Offer Selected | Triggered when an offer is selected. |
| The locale specific name of the offer clicked. e.g. "6 Chilli Cheese" |
|
| ||
| The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d" | ||
| The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835" | ||
| E.g. | ||
| E.g. | ||
| E.g. | ||
Button Click - Add to Order (Mobile Order) | Triggered after the user adds an offer to Pick Up or Delivery. |
|
|
| E.g.: | ||
|
| ||
Button Click - Redeem In Restaurant (In-Store) | Triggered after the user adds an offer to be redeemed in the restaurant. |
|
|
| E.g.: | ||
|
| ||
Button Click - Remove Offer applied to Mobile Order | Triggered when the user removes the offer from the Pick Up/Delivery order from the Offers List. |
|
|
Offer Favorite Added | Triggered after the user favorited an offer. |
| The locale specific name of the offer clicked. e.g. "6 Chilli Cheese" |
|
| ||
| The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d" | ||
| The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835" | ||
| E.g. | ||
| E.g. | ||
Button Click - Select a Tab | Triggered when a section tab is clicked. |
|
|