Get Offer History

API endpoint to fetch historical details for a specific offer. Use it to get the status of each offer event.

Method: GET Base URL: https://api.adgatemedia.com/v1/user-based-api/offer-history

Required Query Parameters

Parameter	Description	Type	Example
aff_id	Your affiliate ID. Can be found on the Offers API page.	Any Integer	60000
api_key	Your API key. Can be found on the Offers API page.	Any String	941bd1fecf7e6596823b895e04df3a0c
wall_code	Wall code that can be found on the AdGate Rewards page	String	nQug
user_id	The affiliate's user ID. Max length 255 bytes	String	user12345
offer_id	The ID of the offer	Integer	12345

Optional Query Parameters

Parameter	Description	Type	Example
lang	The language as provided by the browser (from Accept-Language HTTP header). Defaults to English if not provided.	String	en-US,en;q=0.5

Response

Field	Note	Type	Example
offer_id	Offer ID	int	341022
anchor	Offer title to display to users	string	Playstation 5
description	Description to display to the user	string	Enter to win a Playstation 5!
requirements	What the user should do to complete an offer	string	Sign up with valid information and complete the full survey.
disclaimer	A field to display with each offer. Replace the ${sitename} macro yourself.	string	This offer is presented to you by ${sitename} on behalf of a third party merchant
icon_url	Square icon URL	string	https://main-p.agmcdn.com/offers/1639000851514.jpg
contact_url	Link to the contact page	string	https://seek.gg/contact/nQ/testing-prodege/360819
continue_url	URL to redirect the user to	string	ttps://seek.gg/vc/nQ/users/testing-prodege/offers/360819?source_type=live_offer_api
started_on	The unix timestamp of the first click	int	1676040060
app_metadata.app_id	App ID on the mobile app store. It can be either App Store or Google Play Store app ID.	string|null	1596736236
app_metadata.categories	An array of app metadata categories.	array|null	["Games", "Casual", "Puzzle"]
app_metadata.screenshot_urls	An array of app metadata screenshot URLs.	array|null	["https://is1-ssl.mzstatic.com/image/thumb/Purple126/v4/39/88/3a/39883ae6-4f45-9879-c849-aedb4d5ab40c/2e706b4c-baf0-456b-ad67-81db322f75a8_CLASSIC22_202203_2688x1242_Screenshots_01_en-US.png/643x0w.png"]
app_metadata.video_urls	An array of app metadata video URLs.	array|null	["https://play.google.com/video/lava/web/player/yt:movie:dSg_iqQpKYA?autoplay=1&authuser=0&embed=play"]
events	An array of events the user may complete to earn points. Each event is an object.	array	[see below]
events.#.uuid	ID of the event	string	0dc43f54-135a-46a4-a51c-a2c5f3cfdac0
events.#.name	Event name to display to the user	string	Completed
events.#.type	"flat" or "dynamic". Flat events have static point values. Dynamic events will have varying payouts.	string	flat
events.#.multiple_conversions_allowed	Whether the user is allowed to complete the event multiple times.	bool	FALSE
events.#.payable	Whether the event pays anything to the user	bool	TRUE
events.#.status	One of the following: 'viewed', 'pending', 'completed', 'cancelled'	string	viewed
events.#.timestamp	The unix timestamp of the last conversion, if any	int|null	1672242051
events.#.promised_flat_points	The number of points the user will be rewarded upon completion. Will be 0 if the event is not payable. Will be null if the event is a dynamic payout type.	float|null	126.72
events.#.promised_flat_payout	The payout that will be awarded for completing this event. Will be 0 if the event is not payable.	float|null	46.22
events.#.dynamic_display_type	Either "up_to" or "commission". This determines how the potential points are displayed.	string|null	up_to
	"up_to": display "Up to {dynamic points amount}
	"commission": display "{dynamic points amount} per ${dynamic payout amount}
events.#.promised_dynamic_points	Amount of dynamic points promised to the user per the {payout} below. Example: "Earn {promised_dynamic_points} per ${promised_dynamic_payout}" -- "Earn 100 points per $1".	float|null	187.9
events.#.promised_dynamic_payout	The dollar amount to display for dynamic display. Example: "Earn {promised_dynamic_points} per ${promised_dynamic_payout}" -- "Earn 100 points per $1".	float|null	0.1
events.#.approved_conversions	How many approved (payable) conversions there are.	int	0
events.#.approved_points	How many approved (payable) points there are.	float	0
events.#.pending_conversions	How many conversions are pending	int	0
events.#.pending_points	How many points are pending.	float	0
events.#.pending_reasons	Explains, in text, why the event is in "pending" status.	string	Waiting for phone verification
events.#.event_type_id	ID used to identify the event type	int|null	1
events.#.time_played	Time played goal associated with the event.	object|null
events.#.time_played.id	Time played goal id.	int	100
events.#.time_played.goal_unit	The unit of time that the goal is measured in. Allowed values are: NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS, HALF_DAYS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA, ERAS, FOREVER.	string	DAYS
events.#.time_played.goal_unit_count	The quantity of goal unit required to complete the goal.	int	7

Sample Response

{
    "data": {
        "offer_id": 360819,
        "anchor": "Opinion Labs",
        "description": "Answer some profile questions about yourself and our system will determine if the selected survey is a good fit based on your answers. Complete surveys honestly and completely. Get paid for your efforts through your favorite rewards platform. ",
        "requirements": "Enter your profile information and complete one survey from the available options. Fake information will not be credited. Can be completed multiple times.",
        "disclaimer": "This offer is presented to you by ${sitename} on behalf of a third party merchant",
        "icon_url": "https://main-p.agmcdn.com/offers/1613580417599.gif",
        "events": [
            {
                "uuid": "48097169-5ef7-476a-92ac-869884120096",
                "name": "Completed",
                "type": "flat",
                "multiple_conversions_allowed": true,
                "approved_conversions": 0,
                "approved_points": 0,
                "pending_conversions": 0,
                "event_type_id": 1,
                "pending_points": 0,
                "status": "viewed",
                "payable": true,
                "timestamp": null,
                "pending_reasons": "",
                "flat_points": 125,
                "flat_payout": 1.25,
                "flat_promotional_points": null,
                "dynamic_display_type": null,
                "dynamic_points": null,
                "dynamic_payout": null,
                "dynamic_promotional_points": null
            }
        ],
        "started_on": 1676040060,
        "contact_url": "https://adgaterewards.com/contact/nQ/user12345/360819",
        "continue_url": "ttps://seek.gg/vc/nQ/users/testing-prodege/offers/360819?source_type=live_offer_api"
    }
}

Offer Event Types

The following table shows the list of offer event type ids that can be retrieved in the API:

ID	Type
1	Install
2	Event
3	Purchase
NULL	N/A