Offer Anatomy

10min
Overview
When calling the Moments API, you will receive a list of offers provisioned to your account. This document will guide you through the structure of these offers, explaining the key components that make up an offer and how to construct and display them using the Moments API response.
Offer Display Units
﻿Based on the Moments API response, you have the flexibility to display offers in various formats, depending on your preference. Below are two examples commonly used in our Moments JS SDK: 
Single Offer Unit (SOU)
Multi Offer Unit (MOU)
In this guide, we’ll walk through the anatomy of an offer and demonstrate how you can leverage the Moments API response to build these display types. The API response provides all the necessary details, giving you the flexibility to present offers in a way that best aligns with your platform’s needs.
These are just examples of display units. You are not limited to implementing them in a specific way. Feel free to design the display format that works best for your use case.
Single Offer Unit (SOU)
The Single Offer Unit (SOU) displays one offer at a time to the user.
Users can engage with a single offer at a time, allowing them to focus on one option.
Includes navigation functionality, enabling users to browse through other available offers individually, one at a time. 
﻿
Single Offer Unit
﻿
Multi Offer Unit (MOU)
The Multi Offer Unit (MOU) enables the simultaneous display of multiple offers.
Multiple offers are presented side by side, enabling users to view and explore different options at a glance.
This unit is ideal for presenting various offers at once.
Multi Offer Unit
﻿
﻿
API Response
The following example is a truncated example of the Moments API response. For a complete response and detailed information, please refer to the Moments API Documentation and try out the API request.
Moments API Response Example
{
    "data": {
        "offers": [
            {
                "id": 4008,
                "title": "You Unlocked MomentScience For 90 Days - Free!",
                "description": "MomentScience lets you capture  revenue across your user’s moments. Delight your users with relevant Offers at the right time. Get 3 months free!",
				"click_url": "https://track.momentscience.com/sdk/offer-click?o_id=4008&c_id=1284&p_id=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string",
				"image": "https://adpx.b-cdn.net/campaigns/1284/598d561b6afb86b76d3137545572a3a9.png",
                "mini_text": "",
                "pixel": "https://track.momentscience.com/sdk/v2/impression/p.png?o_id=4008&c_id=1284&p_id=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string&cbuster=%7BCBUSTER%7D",
                "cta_yes": "Try out MomentScience!",
                "cta_no": "No, Thanks",
                "useraction_cta": "",
                "useraction_url": "",
                "adv_pixel_url": "",
                "beacons": {
				  "close": "https://track.momentscience.com/event/record/close?oid=4008&cid=1284&pid=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string",
				  "no_thanks_click": "https://track.momentscience.com/event/record/no_thanks_click?oid=4008&cid=1284&pid=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string"
                },
                "creatives": [
                    {
                        "id": 939,
                        "url": "https://adpx.b-cdn.net/campaigns/1284/598d561b6afb86b76d3137545572a3a9.png",
                        "height": 1200,
                        "width": 1200,
                        "type": "png",
                        "is_primary": true,
                        "aspect_ratio": 1
                    }
                ],
                "short_description": "Capture revenue across your user’s moments. Get 3 months free!",
                "short_headline": "3 Free Months Of MomentScience!",
                "advertiser_name": "MomentScience"
            },
           {...Contents of Other Offer/s...}
		 
        ],
        "settings": {
         "offerwall_url": "https://get.perkswall.com/offerwall?accountId=fbe15a0c6f803ef4&offer_count=3&auto_show=1&show_logo=1&show_header=1&show_shadow=0&show_image=1&font_family=Open+Sans&session_id=1d979e855122b01d5eac8622e3a7937609abefdc",
         "offerwall_cta": "More Offers",
        },
        "count": 3,
        "privacy_url": "https://www.momentscience.com/end-user-privacy-policy"
    }
}
{
    "data": {
        "offers": [
            {
                "id": 4008,
                "title": "You Unlocked MomentScience For 90 Days - Free!",
                "description": "MomentScience lets you capture  revenue across your user’s moments. Delight your users with relevant Offers at the right time. Get 3 months free!",
				"click_url": "https://track.momentscience.com/sdk/offer-click?o_id=4008&c_id=1284&p_id=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string",
				"image": "https://adpx.b-cdn.net/campaigns/1284/598d561b6afb86b76d3137545572a3a9.png",
                "mini_text": "",
                "pixel": "https://track.momentscience.com/sdk/v2/impression/p.png?o_id=4008&c_id=1284&p_id=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string&cbuster=%7BCBUSTER%7D",
                "cta_yes": "Try out MomentScience!",
                "cta_no": "No, Thanks",
                "useraction_cta": "",
                "useraction_url": "",
                "adv_pixel_url": "",
                "beacons": {
				  "close": "https://track.momentscience.com/event/record/close?oid=4008&cid=1284&pid=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string",
				  "no_thanks_click": "https://track.momentscience.com/event/record/no_thanks_click?oid=4008&cid=1284&pid=1501&sess_id=03a7c834ffce7ff88ff45f980577ea42a03ec904&fp=string"
                },
                "creatives": [
                    {
                        "id": 939,
                        "url": "https://adpx.b-cdn.net/campaigns/1284/598d561b6afb86b76d3137545572a3a9.png",
                        "height": 1200,
                        "width": 1200,
                        "type": "png",
                        "is_primary": true,
                        "aspect_ratio": 1
                    }
                ],
                "short_description": "Capture revenue across your user’s moments. Get 3 months free!",
                "short_headline": "3 Free Months Of MomentScience!",
                "advertiser_name": "MomentScience"
            },
           {...Contents of Other Offer/s...}
		 
        ],
        "settings": {
         "offerwall_url": "https://get.perkswall.com/offerwall?accountId=fbe15a0c6f803ef4&offer_count=3&auto_show=1&show_logo=1&show_header=1&show_shadow=0&show_image=1&font_family=Open+Sans&session_id=1d979e855122b01d5eac8622e3a7937609abefdc",
         "offerwall_cta": "More Offers",
        },
        "count": 3,
        "privacy_url": "https://www.momentscience.com/end-user-privacy-policy"
    }
}
﻿
Display Unit Components
This section outlines key API parameters for constructing a Multi Offer Unit (MOU) and Single Offer Unit (SOU).
A. offers[].image
Use for the URL of the offer's main creative.
B. offers[].title
Use for the offer’s title or headline.
Note: Useoffers[].short_headline for smaller formats if space is limited.
C. offers[].description
Use for the offer’s description.
Note: Use offers[].short_description for smaller formats if space is limited.
D. offers[].click_url
Use for the URL that the positive CTA should route the user to.
Set the button's text using offers[].cta_yes.
E. offers[].beacons.no_thanks_click
Use for firing a GET request when the negative CTA is clicked.
This is typically paired with offers[].cta_no, which contains the button label.
Single Offer Unit
﻿
Multi Offer Unit
﻿
F. offers[].beacons.close﻿
This parameter provides a URL that is triggered via a GETrequest when the close button is clicked.
It is primarily intended for Single Offer Units (SOU) to track and report user interactions, specifically indicating which offer the offer unit was closed on.
G. settings.offerwall_url﻿
This parameter specifies the Perkswall URL to which users are redirected after clicking on the Perkswall button.
The button text can be retrieved from settings.offerwall_cta.
Refer to the Perkswall documentation for detailed instructions on implementing and configuring Perkswall. 
Offer Display Tracking Pixel
The Offer Display Tracking Pixel is critical in tracking when an offer is shown to the user, providing essential data for performance monitoring and analytics. It is triggered every time the associated creative is rendered on the user’s screen.
Parameter Location: data.offers[].pixel
Type: URL
Usage Guidelines
The pixel URL should be fired as soon as the creative is visible to the user, representing that the offer was shown.
Ensure the pixel fires only once per impression to avoid duplicate data.
Send an HTTP GET request to the URL in data.offers[].pixel.
This pixel helps ensure accurate measurement of offer impressions, which is vital for understanding user engagement, optimizing campaigns, and analyzing the effectiveness of the displayed offers.
﻿
📢 If you're running into any issues while going through the integration process, feel free to contact us at help@momentscience.com﻿
Updated 15 Jan 2025
Did this page help you?
Moments API
Perkswall API
Offer Anatomy

Overview

Offer Display Units

Single Offer Unit (SOU)

﻿

Multi Offer Unit (MOU)

API Response

Display Unit Components

Offer Display Tracking Pixel
