Get History
API endpoint to fetch user history. It returns a list of all offers the user has interacted with, and how many points were earned for each one.
Use the "Get Offer History" API endpoint to get more details about each offer.
Method: GET Base URL: https://api.adgatemedia.com/v1/user-based-api/history
Required Query Parameters
Parameter
Description
Type
Example
user_id
The affiliate's user ID. Max length 255 bytes
String
user12345
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
continue_playing
A special boolean flag that can be used to retrieve the offers for "Continue Playing" section.
Bool
true
Response
An array of records will be returned on success. Each record will have the following fields:
offer_id
The offer's unique identifier on AdGate Media's dashboard.
integer
360819
anchor
The title of the offer as it is displayed to the user.
string
Opinion Labs
description
Description to display to the user
string
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
What the user should do to complete an offer
string
Enter your profile information and complete one survey from the available options. Fake information will not be credited. Can be completed multiple times.
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
confirmation_time
Confirmation time.
string
Confirms Instantly
categories
An array of the category names that the offer belongs to.
array
["Free", "Surveys", "CPA"]
icon_url
Square image to display to the user.
string
https://main-p.agmcdn.com/offers/1564507470875.gif
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"]
continue_url
URL to redirect the user to
string
https://seek.gg/vc/nQ/users/testing-prodege/offers/360819?source_type=live_offer_api
latest_date
Date of the latest click or conversions
timestamp
1676040060
points
Total points earned by the user for this offer. This does not include any points that are pending.
float
300.02
completed_events
Total number of events that the user has completed for this offer.
integer
1
completed
Whether all events have been completed on the offer. Can be used to display the offer in a "Completed" section.
bool
false
total_points
Total number of points earnable on the offer.
float
100
total_promotional_points
Total number of promotional points earnable on the offer.
float|null
total_approved_points
Sum of approved event points.
float
0
total_pending_points
Sum of pending event points.
float
0
total_cancelled_points
Sum of charged back event points.
float
0
total_events
Total number of visible events.
int
1
total_approved_events
Total number of events approved, including non payable.
int
0
total_pending_events
Total number of events pending, including non payable.
int
0
total_cancelled_events
Total number of events charged back, including non payable.
int
0
has_pending_conversions
If the offer has pending conversions
bool
false
contact_url
Link to the contact page
string
https://seek.gg/contact/nQ/testing-prodege/360819
next_event
ID of the next event that the user can complete, including non-payable events.
string|null
0dc43f54-135a-46a4-a51c-a2c5f3cfdac0
next_payable_event
ID of the next payable event that the user can complete.
string|null
0dc43f54-135a-46a4-a51c-a2c5f3cfdac0
hours_left
How many session hours are left from the first click that has converted.
int|null
720
events
An array of events the user may complete to earn points. Each event is an object.
array
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
true
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.#.flat_points
The number of points the user was promised to 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.#.flat_promotional_points
The number of promotional points the user was promised to be rewarded upon completion. nullif there was no promotion.
float|null
146.72
events.#.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. "up_to": display "Up to {dynamic points amount} "commission": display "{dynamic points amount} per ${dynamic payout amount}
string|null
up_to
events.#.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.#.dynamic_promotional_points
Amount of promotional dynamic points promised to the user per the {payout} below. nullif there was no promotion.
events.#.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|null
0
events.#.pending_conversions
How many conversions are pending
int
0
events.#.pending_points
How many points are pending.
float|null
0
events.#.event_type_id
ID used to identify the event type. See bottom of this page for the complete list.
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
Offer Event Types
The following table shows the list of offer event type ids that can be retrieved in the API:
1
Install
2
Event
3
Purchase
NULL
N/A
Last updated