# Get History 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**](https://api.adgatemedia.com/v1/user-based-api/history) ### Required Query Parameters | Parameter | Description | Type | Example | | ---------- | ---------------------------------------------------------------------------------------------------------------- | ----------- | ---------------------------------- | | aff\_id | Your affiliate ID. Can be found on the [Offers API page](http://panel.adgatemedia.com/affiliate/api/keys). | Any Integer | `60000` | | api\_key | Your API key. Can be found on the [Offers API page](http://panel.adgatemedia.com/affiliate/api/keys). | Any String | `941bd1fecf7e6596823b895e04df3a0c` | | wall\_code | Wall code that can be found on the [AdGate Rewards page](https://panel.adgatemedia.com/affiliate/vc-walls/index) | String | `nQug` | | user\_id | The affiliate's user ID. Max length 255 bytes | String | `user12345` | ### Optional Query Parameters
ParameterDescriptionTypeExample
ParameterDescriptionTypeExample
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
continue_playingA special boolean flag that can be used to retrieve the offers for "Continue Playing" section.Booltrue
offer_idsA comma-separated list of integer offer IDs to filter by.String1477425,148199
### Response An array of records will be returned on success. Each record will have the following fields: | Field | Note | Type | Example | | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | offer\_id | The offer's unique identifier on AdGate Media's dashboard. | integer | 360819 | | product\_id | A unique string shared between offers which belong to same product, e.g. same mobile app. | string | JEEDPNV72ZX4FFY81K2HSSTC | | product\_name | The offer's product name | string | Product #1 | | 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 | | | 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 | \[""] | | continue\_url | URL to redirect the user to | string | | | 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 | | tx\_id | The primary transaction ID, or click ID, associated with this offer. | string | 12972967ae33a42154a0794dc3801866a | | has\_pending\_conversions | If the offer has pending conversions | bool | false | | contact\_url | Link to the contact page | string | | | 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. 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 | | | 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.#.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.#.payable | Whether the event pays anything to the user | bool | true | | events.#.status | One of the following: 'viewed', 'pending', 'completed', 'cancelled' | string | viewed | | events.#.expires\_at | If there is a time limit for this event, this contains the unix timestamp when the event expires. | int\|null | 1738598535 | | events.#.minutes\_left | If there is a time limit for this event, this contains the minutes remaining. | float\|null | 67.1 | | 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. `null`if 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. `null`if 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 | | events.#.timestamp | The UNIX timestamp of the last conversion, if any. | int\|null | 1234567890 | | creatives | Links to offer creatives | object | | | creatives.images | Links to offer images | object | { "275x275": "", "400x400": " | | is\_game | Whether the offer is a game offer. | bool | FALSE | | started\_on | The UNIX timestamp of the first click. | int | 1234567890 | | things\_to\_know | An extra requirement to offers. | array\ | \["You must click \\"Allow\” if tracking permission is requested within the app."] | | hours\_left | The number of hours left to convert any offer event. | integer\|null | 1 | | operating\_systems | OS information | object | | | operating\_systems.min\_os\_version | Min OS version | string | 10 | | operating\_systems.max\_os\_version | Max OS version | string | 10.2 | | operating\_systems.operating\_system | OS name | string | "ios" | #### Sample Response ```json { "data": [ { "offer_id": 360819, "product_id": "01JEEEBHSK572BWPQC0AYQZF30", "product_name": "Product #1", "icon_url": "https://main-p.agmcdn.com/offers/1613580417599.gif", "anchor": "Opinion Labs", "latest_date": 1676040060, "points": 0, "completed_events": 0, "completed": false, "total_points": 100, "total_promotional_points": null, "total_approved_points": 0, "total_pending_points": 0, "total_cancelled_points": 0, "total_events": 0, "total_approved_events": 0, "total_pending_events": 0, "total_cancelled_events": 0, "tx_id": "12972967ae33a42154a0794dc3801866a", "events": [ { "uuid": "7731b964-845d-46f1-8028-10b892ee8a67", "name": "Completed", "type": "flat", "payable": true, "event_type_id": 1, "flat_points": 490, "flat_payout": 4.9, "flat_promotional_points": null, "dynamic_display_type": null, "dynamic_points": null, "dynamic_payout": null, "dynamic_promotional_points": null, "approved_points": 0, "approved_conversions": 0, "pending_points": 0, "pending_conversions": 0, "cancelled_points": 0, "cancelled_conversions": 0, "status": "viewed", "timestamp": 12345567890 } ], "operating_systems": [ { "max_os_version": null, "min_os_version": null, "operating_system": "ios" } ], "next_event": "7731b964-845d-46f1-8028-10b892ee8a67", "next_payable_event": "7731b964-845d-46f1-8028-10b892ee8a67", "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", "confirmation_time": "Confirms Instantly", "categories": [ "Free", "Surveys", "CPA" ], "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" }, }, "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", "has_pending_conversions": false, "hours_left": 720, "is_game": false, "started_on": 12345567890, "hours_left": 1, "things_to_know": [ "You must click \“Allow\” if tracking permission is requested within the app." ], } ] } ``` #### 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 | --- # 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-history.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.