Moments and Perkswall API Implementation Checklist
Welcome to the MomentScience Implementation Checklist! This document is your go-to resource for integrating MomentScience Moments and Perkswall APIs into your platform as a final check to confirm your integration is implemented correctly.
Moments API
Fire a successful GET call to the provided offers[].pixel URL.
- Importance: Records an individual Offer’s impression for performance reporting and yield optimization.
Fire a successful GET call to the provided offers[].adv_pixel_url URL if available.
- Importance: Meets advertiser requirements for their impression tracking.
Fire a successful GET call to the currently displayed Offer’s offers[].beacons.close URL.
- Importance: Enables behavioral performance reporting to track user interaction within Moments.
Fire a successful GET call to the Offer’s offers[].beacons.no_thanks_click URL.
- Importance: Helps exclude Offer from future display when a user opts out.
Pass a value as the adpx_fp attribute in payload parameters for unique user identification.
- Importance: Enables frequency capping and exclusion of Offers based on user preference.
Send the User’s IP address as the ip attribute in the payload parameters.
- Importance: MomentScience uses the user’s IP address to determine the user’s geography for valid Offers.
Send User Agent as the ua attribute in the payload parameters.
- Importance: MomentScience uses the User-Agent value to determine the user’s platform for valid Offers.
When Implementing LoyaltyBoost (Rewarded Offers)
Only implement if you can identify your users to reward them with your Loyalty currency.
Request LoyaltyBoost Offers by passing the query parameter loyaltyboost with values 1 | 2.
- Importance: Ensures that Offers returned are valid for incentivized use.
- Importance: Allows you to be notified when your user converts on a LoyaltyBoost Offer to reward them with their Loyalty currency and determine the amount.
Pass a value as the adpx_fp attribute in payload parameters to represent a unique user.
- Importance: Enables MomentScience to prevent showing a user a LoyaltyBoost Offer that they have already converted on.
Pass a custom key-value attribute in payload parameters to identify where to debit the user's Loyalty currency (e.g., loyaltyid=12345566).
- Importance: When a user converts on a LoyaltyBoost Offer, our postback will contain this information along with the conversions payout amount (in USD) in the payload. You can use it to identify which account to debit their Loyalty currency to and calculate the reward amount for your user.
Fire a successful GET call to the provided offers[].pixel URL.
- Importance: Records an individual Offer’s impression for performance reporting and yield optimization.
Fire a successful GET call to the provided offers[].adv_pixel_url URL if available.
- Importance: Meets advertiser requirements for their impression tracking.
Send the User’s IP address as the ip attribute in the payload parameters.
- Importance: MomentScience uses the user’s IP address to determine the user’s geography for valid Offers.
Send User Agent as the ua attribute in the payload parameters.
- Importance: MomentScience uses the User-Agent value to determine the user’s platform for valid Offers.
When Implementing LoyaltyBoost (Rewarded Offers)
Only implement if you can identify your users to reward them with your Loyalty currency.
Request LoyaltyBoost Offers by passing the query parameter loyaltyboost with values 1 | 2.
- Importance: Ensures that Offers returned are valid for incentivized use.
- Importance: Allows you to be notified when your user converts on a LoyaltyBoost Offer to reward them with their Loyalty currency and determine the amount.
Pass a value as the adpx_fp attribute in payload parameters to represent a unique user.
- Importance: Enables MomentScience to prevent showing a user a LoyaltyBoost Offer that they have already converted on.
Pass a custom key-value attribute in payload parameters to identify where to debit the user's Loyalty currency (e.g., loyaltyid=12345566).
- Importance: When a user converts on a LoyaltyBoost Offer, our postback will contain this information along with the conversions payout amount (in USD) in the payload. You can use it to identify which account to debit their Loyalty currency to and calculate the reward amount for your user.
📢 If you're running into any issues while going through the integration process, feel free to contact us at [email protected]