Get Offers By Ids
Gets the available information for the provided offer IDs, including interaction history.
Returns offers for the provided offer IDs. Offers with interaction history (click and conversions) will include history keys with the same history fields as in the "Get History" endpoint. If offers have no history, the history values will be null. If offers have no history and are also not available for the end user to interact with, they will be included in the unavailable_offers section with a reason code.
Offers that have clicks are still eligible to be clicked again, and thus have a click_url. Offers that cannot be clicked will have a null click URL.
Method: GET Base URL: https://api.adgatemedia.com/v1/user-based-api/offers-by-ids
Required Query Parameters
aff_id
Any Integer
60000
api_key
Any String
941bd1fecf7e6596823b895e04df3a0c
wall_code
String
nQug
user_id
The affiliate's user ID. Max length 255 bytes
String
user12345
ip
IP v4 or v6. Used to target offers geographically.
String
127.0.0.1
user_agent
The end-user's user agent, used for device targeting.
String
offer_ids
A comma-separated list of offer IDs to get
String
123,456,789
Optional Parameters
rank_method
One of "cpm" or "cr". Determines how the rank field will be calculated.
String
cpm
s2 s3 s4 s5
Four available subIDs the affiliate can pass to us. We will return them in the affiliate's postback.
String
lang
The language as provided by the browser (from Accept-Language HTTP header). Defaults to English if not provided.
String
override_w2m_devices
A list of the devices the user owns separated by commas. You may use this instead of posting devices to the Devices endpoint. Allowed values are "iphone", "ipad", and "android". Only used if user_agent is a desktop device.
String
iphone,android
Response
The response will contain two arrays: offers and unavailable_offers
Each record in offers will contain the following fields:
id
Offer ID
int
341022
anchor
Offer title to display to users
string
Playstation 5
things_to_know
Offer information that can be presented as a bullet-point list
array
[ "Enter to win a Playstation 5!", "You must click “Allow” if tracking permission is requested within the app." ]
session_hours
Offer is valid for that many hours
int
720
offer_expires_at
Offer expiration timestamp
int
1741370828
requirements
What the user should do to complete an offer
string
Sign up with valid information and complete the full survey.
description
Description to display to the user
string
Enter to win a Playstation 5!
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
product_id
A unique string shared between offers which belong to same product, e.g. same mobile app.
string
01JEEDPNV72ZX4FFY81K2HSSTC
confirmation_time
Text that described how long it takes to receive credit
string
Confirms Instantly
creatives
Links to offer creatives
object
creatives.images
Links to offer images
object
{ "275x275": "https://example.org/275x275.jpg", "400x400": "https://example.org/400x400.jpg"}
pending_time
Time in minutes that a reward will be held from the user following completion
int
60
mobile_verification_required
Whether the end user needs to verify their mobile phone number
bool
false
web2mobile
Whether this offer must be accessed on the user's mobile device. You must send us the devices the user owns via the [POST devices] endpoints. If no devices are stored, web2mobile offers will not be returned.
bool
FALSE
web2mobile_devices
Array of devices the users must access the user on. NULL if not a web2mobile offer. The list of applicable devices is taken from the devices stored for that particular user (see the other devices API endpoint)
array|null
["iphone", "ipad"]
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"]
is_game
Whether the offer is a game offer
bool
FALSE
click_url
URL to redirect the user to
string
https://seek.gg/vc/nQ/users/testuser/offers/360819?source_type=live_offer_api
support_url
URL of the support form for this offer
string
https://seek.gg/offer/contact/nqqYp2g/1666524?s1=testuser
impression_url
URL to notify that the offer was viewed
string
https://seek.gg/v1/user-based-api/impression?funnel_id=01JKBMPR5QYT91EGGV1R62DB2W&wall_code=nqqYp2g&user_id=testuser&offer_id=1666524
icon_url
Square icon URL
string
https://main-p.agmcdn.com/offers/1639000851514.jpg
categories
Offer categories
array
[ "CPI", "iPad", "iPhone" ]
total_points
Total points the user may earn
float
126.72
total_points_promotional
If a promotion is currently in progress, the amount of points they will earn. If not null, this should be used instead of total_points.
float|null
187.9
sticky
If an offer should be pinned to the top of the offer wall
bool
TRUE
rank
The rank of the offer according to the "rank_method" requested
int
1
history
End user history of interactions with this offer
object|null
history.completed_events
Number of completed events
int
1
history.continue_url
URL to the offer
string
https://play.google.com/store/apps/details?id=com.newmegames.unblocktrafficpuzzle
history.has_pending_conversions
Are there pending conversions?
bool
false
history.latest_date
Timestamp of the latest click or conversion
int
1738615121
history.completed
Is offer completed?
bool
false
history.next_event
UUID of the next event for the user to complete
string
8bf0cf49-2f9c-4051-a2a7-9704a15731f3
history.next_payable_event
UUID of the next event for the user to complete
string
dee3fea7-3c18-4dc3-9b71-021528be51d0
history.total_approved_events
int
1
history.total_approved_points
float
70
history.total_cancelled_events
int
0
history.total_cancelled_points
float
0
history.total_pending_events
int
0
history.total_pending_points
float
0
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.#.payable
Whether the event pays anything to the user
bool
TRUE
events.#.ttc_minutes
Minutes to complete this event after the click
int
43200
events.#.expires_at
Timestamp when the event expires
int
1741370829
events.#.flat_points
Will be 0 if the event is not payable.
float|null
126.72
events.#.flat_payout
Will be 0 if the event is not payable.
float|null
46.22
events.#.flat_promotional_points
Points if there is an ongoing promotion
float|null
187.9
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
Described above
float|null
187.9
events.#.dynamic_payout
For "commission", the dollars amount to use in the phrase above
float|null
1
events.#.dynamic_promotional_points
Described above
float|null
0
events.#.event_type_id
ID used to identify the event type
Integer|null
1
events.#.time_played
Time played goal associated with the event.
object|null
events.#.time_played.id
Time played goal id.
integer
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.
integer
7
events.#.multiple_conversions_allowed
Whether this event can be converted multiple times
bool
true
events.#.multiple_conversions_rules
The rules for multiple event conversions
object|null
events.#.multiple_conversions_rules.rule_type
Can be UNLIMITED, TOTAL_CONVERSIONS or INTERVAL
string
"UNLIMITED"
events.#.multiple_conversions_rules.x_conversions
Number of conversions allowed
int
3
events.#.multiple_conversions_rules.every_y_seconds
Only used for INTERVAL type: allows X conversions every Y seconds
int
600
events.#.history
End user interaction with this offer event
object|null
events.#.history.pending_reasons
An array of reasons why conversion for this event is pending
array|null
events.#.history.pending_reasons.#.reason
Can be PHONE_VERIFICATION or DELAYED_OFFER
string
PHONE_VERIFICATION
events.#.history.pending_reasons.#.auto_accept_in_days
In how many days this pending reason will be auto-resolved or auto-rejected
float
1
events.#.history.pending_reasons.#.auto_accept_in_hours
In how many hours this pending reason will be auto-resolved or auto-rejected
float
4
events.#.history.pending_reasons.#.auto_accept_in_minutes
In how many minutes this pending reason will be auto-resolved or auto-rejected
float
240
events.#.history.minutes_left
How many minutes are left to complete this offer event
float
40700.21
events.#.history.approved_conversions
int
1
events.#.history.approved_points
float
65
events.#.history.cancelled_conversions
int
0
events.#.history.cancelled_points
float
0
events.#.history.pending_conversions
int
0
events.#.history.pending_points
float
0
events.#.history.status
Can be "viewed", "pending", "completed" or "cancelled"
string
"viewed"
Each record in unavailable_offers will contain the following fields:
offer_id
Offer ID
int
341011
unavailable_reasons
An array of reasons why this offer is not available
array
unavailable_reasons.#.reason
string
"This device or browser is not allowed"
unavailable_reasons.#.code
int
2067
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
Was this helpful?