|
| 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 |
| epc | Average network EPC in dollars | string | "0.23" |
| 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 |
| 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 |
| 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
}
]
|
#### Sample Response
```json
{
"data": [
{
"id": 1666524,
"anchor": "Clash of Clans",
"things_to_know": [
"Join millions of players worldwide as you build your village, raise a clan, and compete in epic Clan Wars!",
"You must click “Allow” if tracking permission is requested within the app."
],
"session_hours": 720,
"offer_expires_at": 1741370828,
"requirements": "Join millions of players worldwide as you build your village, raise a clan, and compete in epic Clan Wars! You must click “Allow” if tracking permission is requested within the app.",
"description": "Clash of Clans",
"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.",
"product_id": "01JEEDPNV72ZX4FFY81K2HSSTC",
"product_name": "Product #1",
"confirmation_time": "Confirms Instantly",
"creatives": {
"images": {}
},
"pending_time": 0,
"is_game": true,
"mobile_verification_required": false,
"app_metadata": {
"app_id": "529479190",
"categories": [
"Games",
"Action",
"Entertainment",
"Strategy"
],
"screenshot_urls": [
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/04/df/6b/04df6bc3-d532-a745-a34c-47df801d8c4d/627799b5-bcad-4b62-8066-ffc4017dc4c4_clash_2208x1242_1.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/92/5a/71/925a718f-73b4-495e-c7a6-039c4194cf76/59bd05b8-05cc-4e51-9905-7c700424b34b_clash_2208x1242_2.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/df/34/d0/df34d02e-4609-5a42-360e-c490771fe283/f771935d-9818-48e1-8bc3-eb326d59e774_clash_2208x1242_3.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/65/d9/0a/65d90adb-eaec-7b0d-5a72-33027b96b717/745ae951-68bc-4827-a9b5-17212cc109ed_clash_2208x1242_4.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/7a/75/73/7a757339-77aa-a8a9-0077-251432585015/a98b615c-678b-439b-83c9-323526f861d8_clash_2208x1242_5.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/76/66/d8/7666d852-4b8b-5727-bca4-6e4278149915/bfc194c6-f848-4ed7-ae04-d37a24c00150_clash_2208x1242_6.jpg/626x0w.jpg",
"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/32/d9/6e/32d96e31-fdb7-17ce-845d-438f3dc7204b/9585bee6-547b-4ed0-bab6-be8ec441a0cb_clash_2208x1242_7.jpg/626x0w.jpg"
],
"video_urls": []
},
"web2mobile": false,
"web2mobile_devices": null,
"click_url": "https://shortlink12.agm.mobi/vc/nqqYp2g/users/smurciac-2797-v2/offers/1666524?source_type=user_based_api&funnel_id=01JKBMPR5QYT91EGGV1R62DB2W",
"support_url": "https://wall12.agm.mobi/offer/contact/nqqYp2g/1666524?s1=smurciac-2797-v2",
"impression_url": "https://api12.agm.mobi/v1/user-based-api/impression?funnel_id=01JKBMPR5QYT91EGGV1R62DB2W&wall_code=nqqYp2g&user_id=smurciac-2797-v2&offer_id=1666524",
"icon_url": "https://main-p.agmcdn.com/static/default_icon.png",
"categories": [
"CPI",
"iPad",
"iPhone"
],
"sticky": true,
"events": [
{
"uuid": "a90457b6-4abf-4403-8d5f-eb4abc8ae6eb",
"name": "dynamic_event. Complete within 1 month 2 days",
"type": "dynamic",
"payable": true,
"event_type_id": null,
"ttc_minutes": 43200,
"expires_at": 1741370829,
"flat_points": null,
"flat_payout": null,
"flat_promotional_points": null,
"dynamic_display_type": "commission",
"dynamic_points": 10,
"dynamic_payout": 1,
"dynamic_promotional_points": null,
"time_played": null,
"multiple_conversions_allowed": true,
"multiple_conversions_rules": {
"rule_type": "UNLIMITED",
"x_conversions": null,
"every_y_seconds": null
}
},
{
"uuid": "7c320062-42e2-4312-95b0-ccac4904128e",
"name": "flat_event. Complete within 1 month 2 days",
"type": "flat",
"payable": true,
"event_type_id": 4,
"ttc_minutes": 43200,
"expires_at": 1741370829,
"flat_points": 10,
"flat_payout": 1,
"flat_promotional_points": null,
"dynamic_display_type": null,
"dynamic_points": null,
"dynamic_payout": null,
"dynamic_promotional_points": null,
"time_played": {
"id": 996,
"goal_unit": "MINUTES",
"goal_unit_count": 6
},
"multiple_conversions_allowed": true,
"multiple_conversions_rules": {
"rule_type": "UNLIMITED",
"x_conversions": null,
"every_y_seconds": null
}
}
],
"total_points": 10,
"total_promotional_points": null,
"epc": "0.00",
"funnel_id": "01JKBMPR5QYT91EGGV1R62DB2W",
"rank": 1,
"roas_goals": [
{
"day": 7,
"goal": 1.33,
"roas": 0.89
}
],
"roas": [
{
"day": 7,
"goal": 1.33,
"roas": 0.89
}
],
}
]
}
```
#### 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
}
}
}
```