# Get Offers By Ids 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**](https://api.adgatemedia.com/v1/user-based-api/offers-by-ids) ### Required Query Parameters
ParameterDescriptionTypeExample
aff_idYour affiliate ID. Can be found on the Offers API page.Any Integer60000
api_keyYour API key. Can be found on the Offers API page.Any String941bd1fecf7e6596823b895e04df3a0c
wall_codeWall code that can be found on the AdGate Rewards pageStringnQug
user_idThe affiliate's user ID. Max length 255 bytesStringuser12345
ipIP v4 or v6. Used to target offers geographically.String127.0.0.1
user_agentThe end-user's user agent, used for device targeting.String
Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0
offer_idsA comma-separated list of offer IDs to getString123,456,789
### Optional Parameters
ParameterDescriptionTypeExample
rank_methodOne of "cpm" or "cr". Determines how the rank field will be calculated.Stringcpm
s2
s3
s4
s5		Four available subIDs the affiliate can pass to us. We will return them in the affiliate's postback.String
langThe language as provided by the browser (from Accept-Language HTTP header). Defaults to English if not provided.String
en-US,en;q=0.5
override_w2m_devicesA 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.Stringiphone,android
### Response The response will contain two arrays: `offers` and `unavailable_offers` Each record in `offers` will contain the following fields: | Field | Note | Type | Example | | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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 | | product\_name | The offer's product name | string | Product #1 | | 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": "", "400x400": " | | 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 | \[""] | | app\_metadata.video\_urls | An array of app metadata video URLs. | array\|null | \[""] | | is\_game | Whether the offer is a game offer | bool | FALSE | | click\_url | URL to redirect the user to | string | | | support\_url | URL of the support form for this offer | string | | | impression\_url | URL to notify that the offer was viewed | string | | | icon\_url | Square icon URL | string | | | 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 | | | 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 | | history.hours\_left | How many session hours are left from the first click that has converted. Calculated from session\_hours in Offers endpoints. | int\|null | 720 | | 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 publisher | 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" | | mmp | The MMP this offer uses for tracking | string | "adjust" | | viewed\_timestamp | The timestamp when a member has clicked the offer but not installed (first offer click). | int | 12345678900 | | roas\_goals | Offer-level ROAS: one object per configured cohort day that we support, with goal vs observed ROAS for the offer network-wide. | array |

"roas\_goals": \[
{
"day": 7,
"goal": 1.33,
"roas": 0.89
}
]

| | roas | Offer + affiliate (wall) level: same cohort idea, but scoped to this wall’s / affiliate’s traffic on the offer. Same object shape as roas\_goals. | array |

"roas": \[
{
"day": 7,
"goal": 1.33,
"roas": 0.89
}
]

| Each record in `unavailable_offers` will contain the following fields:
FieldNoteTypeExample
offer_idOffer IDint341011
unavailable_reasonsAn array of reasons why this offer is not availablearray
unavailable_reasons.#.reasonstring"This device or browser is not allowed"
unavailable_reasons.#.codeint2067
#### Sample Response ```json { "data": { "offers": [ { "id": 1666154, "product_id": "01JEEEBHSK572BWPQC0AYQZF30", "product_name": "Product #1", "funnel_id": "01JKBMR540THT79JAE488Q5754", "session_hours": 720, "offer_expires_at": 1741370875, "confirmation_time": "Confirms in 29 days 9 hours", "pending_time": 42300, "anchor": "Unblock Traffic Puzzle", "things_to_know": [ "First Time Users", "Complete all the events mentioned", "Complete in 30 days" ], "requirements": "First Time Users. Complete all the events mentioned. Complete in 30 days", "description": "Get ready for Unblock Traffic Puzzle – the ultimate brain-teaser where you free cars from jam-packed parking lots! Slide vehicles strategically to clear the path for the red car.", "disclaimer": "*Points will appear as Pending for 30 days. Each person may redeem this offer only ONCE (1 time). This offer is presented to you by ${sitename} on behalf of a third party merchant or sponsor (\"Merchant\"), which advises us when the offer is completed and a reward should be issued. ${sitename} has not evaluated and does not endorse Merchant's views, policies, products or services, which you are encouraged to evaluate for yourself. Have questions? Please contact the ${sitename} Help Center.", "creatives": { "images": { "275x275": "https://my-zone.com/cdn-cgi/image/width=275,height=275/http://dash.agm/storage/jlNex38v.png", "400x400": "https://my-zone.com/cdn-cgi/image/width=400,height=400/http://dash.agm/storage/jlNex38v.png", "580x580": "https://my-zone.com/cdn-cgi/image/width=580,height=580/http://dash.agm/storage/jlNex38v.png", "600x300": "https://my-zone.com/cdn-cgi/image/width=600,height=300/http://dash.agm/storage/iUNZPzll.png", "630x315": "https://my-zone.com/cdn-cgi/image/width=630,height=315/http://dash.agm/storage/iUNZPzll.png", "120x60": "https://my-zone.com/cdn-cgi/image/width=120,height=60/http://dash.agm/storage/iUNZPzll.png", "600x200": "https://my-zone.com/cdn-cgi/image/width=600,height=200/http://dash.agm/storage/CWGuVinS.png" }, }, "is_game": true, "icon_url": "https://main-p.agmcdn.com/EqGN4bmOFBQLKI1n7mRex7a6NeU6UZuhHxuMHxqO.webp", "support_url": "https://wall12.agm.mobi/offer/contact/nqqYp2g/1666154?s1=smurciac-2797-v2", "sticky": null, "epc": null, "rank": null, "mobile_verification_required": null, "web2mobile": null, "web2mobile_devices": null, "click_url": null, "impression_url": null, "history": { "completed_events": 0, "continue_url": "https://play.google.com/store/apps/details?id=com.newmegames.unblocktrafficpuzzle", "has_pending_conversions": false, "latest_date": 1738615121, "completed": false, "next_event": "8bf0cf49-2f9c-4051-a2a7-9704a15731f3", "next_payable_event": "dee3fea7-3c18-4dc3-9b71-021528be51d0", "total_approved_events": 0, "total_approved_points": 0, "total_cancelled_events": 0, "total_cancelled_points": 0, "total_pending_events": 0, "total_pending_points": 0, "hours_left": 720 }, "mmp": "adjust", "viewed_timestamp": 12345678900, "app_metadata": { "app_id": "com.newmegames.unblocktrafficpuzzle", "categories": [ "GAME_PUZZLE" ], "screenshot_urls": [ "https://play-lh.googleusercontent.com/Zx1YSHxoCQzS7S-bEbtB19i1ivCh9Hs3UTxH27jC_-qYGZxbZAm6Mt4nUp9MxNPz5A=w1052-h592", "https://play-lh.googleusercontent.com/uD2p8T0RoYXZX56Dojllg_cnt8uStZBhZCV_6ps78xj0W5MTXH9DZrrdVAqh1EB1q-4=w1052-h592", "https://play-lh.googleusercontent.com/cdA_JAY-tg75MgMxMnk8NBPRZ6SCSQNaj1toBlpu6dlTQR47ctJp4TBVs1ydRU1yEc8=w1052-h592", "https://play-lh.googleusercontent.com/_iA9JksfhKOsU1kO08V6AB7BQlyVWgBt-Iyzeci7cUSyo7JPDcxpJ9Vv8eJ6-jKnOA=w1052-h592" ], "video_urls": [] }, "categories": [ "Android", "CPE", "Free" ], "total_points": 147, "total_promotional_points": null, "events": [ { "uuid": "8bf0cf49-2f9c-4051-a2a7-9704a15731f3", "name": "Play the game!", "type": "flat", "event_type_id": null, "payable": false, "ttc_minutes": null, "expires_at": null, "multiple_conversions_allowed": false, "multiple_conversions_rules": null, "flat_points": 0, "flat_payout": 0, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "time_played": null, "history": { "pending_reasons": null, "minutes_left": null, "approved_conversions": 0, "approved_points": 0, "cancelled_conversions": 0, "cancelled_points": 0, "pending_conversions": 0, "pending_points": 0, "status": "viewed" } }, { "uuid": "dee3fea7-3c18-4dc3-9b71-021528be51d0", "name": "Complete Rank 8. Complete within 1 week", "type": "flat", "event_type_id": null, "payable": true, "ttc_minutes": 10080, "expires_at": 1739219921, "multiple_conversions_allowed": false, "multiple_conversions_rules": null, "flat_points": 6, "flat_payout": 0.63, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "time_played": null, "history": { "pending_reasons": null, "minutes_left": 7350.765516783334, "approved_conversions": 0, "approved_points": 0, "cancelled_conversions": 0, "cancelled_points": 0, "pending_conversions": 0, "pending_points": 0, "status": "viewed" } }, { "uuid": "e9e572e9-78d3-4c31-a0d5-18c366c781c9", "name": "Complete Rank 20. Complete within 1 week", "type": "flat", "event_type_id": null, "payable": true, "ttc_minutes": 10080, "expires_at": 1739219921, "multiple_conversions_allowed": false, "multiple_conversions_rules": null, "flat_points": 8, "flat_payout": 0.85, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "time_played": null, "history": { "pending_reasons": null, "minutes_left": 7350.7655043, "approved_conversions": 0, "approved_points": 0, "cancelled_conversions": 0, "cancelled_points": 0, "pending_conversions": 0, "pending_points": 0, "status": "viewed" } }, { "uuid": "8a7c6aaf-948c-49bf-be2b-ae744a4a7e32", "name": "Complete Rank 40. Complete within 1 month 2 days", "type": "flat", "event_type_id": null, "payable": true, "ttc_minutes": 43200, "expires_at": 1741207121, "multiple_conversions_allowed": false, "multiple_conversions_rules": null, "flat_points": 33, "flat_payout": 3.35, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "time_played": null, "history": { "pending_reasons": null, "minutes_left": 40470.76549773334, "approved_conversions": 0, "approved_points": 0, "cancelled_conversions": 0, "cancelled_points": 0, "pending_conversions": 0, "pending_points": 0, "status": "viewed" } }, { "uuid": "098748ea-fef2-4561-a69c-d16bc4252a21", "name": "Complete Rank 50. Complete within 1 month 2 days", "type": "flat", "event_type_id": null, "payable": true, "ttc_minutes": 43200, "expires_at": 1741207121, "multiple_conversions_allowed": false, "multiple_conversions_rules": null, "flat_points": 100, "flat_payout": 10, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "time_played": null, "history": { "pending_reasons": null, "minutes_left": 40470.76549113333, "approved_conversions": 0, "approved_points": 0, "cancelled_conversions": 0, "cancelled_points": 0, "pending_conversions": 0, "pending_points": 0, "status": "viewed" } } ], "roas_goals": [ { "day": 7, "goal": 1.33, "roas": 0.89 } ], "roas": [ { "day": 7, "goal": 1.33, "roas": 0.89 } ], } ], "unavailable_offers": [ { "offer_id": 1375646, "unavailable_reasons": [ { "reason": "This device or browser is not allowed [2067]", "code": 2067 } ] }, { "offer_id": 1676274, "unavailable_reasons": [ { "reason": "Offer is inactive [2054]", "code": 2054 } ] } ] } } ``` #### 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 | | 4 | Dynamic Event: Adjust | | 5 | Dynamic Event: Playtime | | 6 | Dynamic Event: AppsFlyer | | NULL | N/A | ### Response Meta The response retrieves a meta object containing miscellaneous information about the endpoint such as warnings, total count, etc. #### Warnings The following is a list of warnings retrieved in the endpoint: | Name | Description | | -------------- | --------------------------------------------------------------------------- | | private\_relay | Returns true or false indicating if the user is using iCloud Private Relay. | **Sample Response** ```json { "data": [ // ... ], "meta": { "warnings": { "private_relay": true } } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers-by-ids.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.