APIs Documentation
Moments and Perkswall API Implementation Checklist
29 min
introduction 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 api endpoints moments api docid\ duaxqa4vbbpvihg4cqaac when an offer is shown 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 render the offers\[] terms and conditions string as html importance clearly present the offer’s terms as formatted html if missing, assume no specific terms apply when a user dismisses an offer unit 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 when a user indicates disinterest in a certain offer 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 when using a proxy server 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) docid pa6380adk1dpkskf7t4j 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 handling postback events docid\ jggrs dnl6sskmhsjehuz 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 perkswall api docid\ xy6g73bveuv6vauunvvuk when an offer is shown 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 render the offers\[] terms and conditions string as html importance clearly present the offer’s terms as formatted html if missing, assume no specific terms apply when using a proxy server 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) docid pa6380adk1dpkskf7t4j 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 handling postback events docid\ jggrs dnl6sskmhsjehuz 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 help\@momentscience com