# Get offers | HTTP method | Endpoint | | ----------- | -------------------------- | | **GET** | **/aff/v1/batches/offers** | ## Path parameters | Parameter | Description | | --------- | ---------------- | | all | All offers. | | personal | Personal offers. | ## Query string parameters | Conditions | Parameters | Type | Description | | ---------- | -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | type | type | Possible Values: all · personal | | Offset | offset | offset | Check page scale. | | Limit | limit | limit | The number of date displays in each page. (**Maximum = 100**) | | Sort | sort | sort | Ranking according to the specified field ascending "+", or descending "-". Only id sorting is supported. | | Filters | filters | filter | Query requirements of Specify field. | | | | | EQUAL\_TO NOT\_EQUAL\_TO LESS\_THAN LESS\_THAN\_OR\_EQUAL\_TO GREATER\_THAN GREATER\_THAN\_OR\_EQUAL\_TO | | | id | integer | A string that uniquely identifies this offer. | | | name | string | The name of the this Offer | | | pricing\_type | string | The current pricing\_type of the offer. Possible Values: CPA · CPI · CPL · CPM · CPC · CPS · CPA+CPS | | | offer\_approval | integer | Whether this Offer requires manual approval before an Affiliate can run it. Possible Values: 1 Require Approval 2 Public 3 Private | | | currency | string | The currency of the Offer. | | | conversion\_protocol | integer | The Conversion tracking method to use for the Offer. | | | geo\_country | string | Only support the following ways, EQUAL\_TO、NOT\_EQUAL\_TO For example,filters\[geo\_country]\[EQUAL\_TO]=CN | | | offer\_platform | string | Only support the following ways, EQUAL\_TO、NOT\_EQUAL\_TO For example,filters\[offer\_platform]\[EQUAL\_TO]=PC | | | category | string | Only support the following ways, EQUAL\_TO、NOT\_EQUAL\_TO. For example,filters\[category]\[EQUAL\_TO]=test | | | app\_id | string | The App ID on app store or google play. Only support the following ways, EQUAL\_TONOT\_EQUAL\_TO. For example,filters\[app\_id]\[EQUAL\_TO]=offerslook.com | | Contains | contains | string | List of related objects to return with each result. | | | description | string | A description for the Offer. Default does not return, if needed, by the following ways. For example,contains=description | | | EPC1 | string | Offers can be pulled according to EPC, for example,contains=EPC1,EPC1 means offers is pulled according to EPC of today | | | EPC2 | string | EPC2 means offers is pulled according to EPC of yesterday | | | EPC3 | string | EPC3 means offers is pulled according to EPC of last three days | | | EPC4 | string | EPC4 means offers is pulled according to EPC of last 7 days | | | CR1 | string | Offers can be pulled according to CR, for example,contains=CR1,CR1 means offers is pulled according to CR of today | | | CR2 | string | CR2 means offers is pulled according to CR of yesterday | | | CR3 | string | CR3 means offers is pulled according to CR of last three days | | | CR4 | string | CR4 means offers is pulled according to CR of last 7 days | ## Response body parameters | | Field | Type | Description | | --------------- | ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | offer | | | | | | id | integer | A string that uniquely identifies this offer. | | | name | string | The name of the this offer | | | end\_date | integer | The expiration date of the offer. | | | status | string | The current status of the offer. | | | category | string | The category of the this offer. | | | pricing\_type | string | The current pricing\_type of the offer. Possible Values: CPA · CPI · CPL · CPC · CPS · CPA+CPS | | | payout | string | The payout of the offer. | | | percent\_payout | string | Percent payout. | | | preview\_url | string | URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page. | | | description | string | A description for the Offer. | | | thumbnail | string | The offer’s thumbnail of the link address. | | | offer\_approval | integer | Whether this Offer requires manual approval before an Affiliate can run it. | | | tracking\_link | string | Tracking link. | | | currency | string | The currency of the Offer. | | | carrier | array | Mobile Carrier | | | app\_id | string | the App ID on app store or google play | | | cap\_exceed\_status | boolean | When request type=personal, cap\_exceed\_status field will be returned; true means cap reaches, false means cap unreached. | | | impression\_pixel | string | impression pixel. | | | browser | array | Browser | | | carrier\_mode | integer | carrier\_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude. | | offer\_url | | | | | | type | string | the type of preview url for opposite tracking link: 1). default: the default preview url of this offer. 2).random: the random preview url of this offer. 3).offer url: other types of preview urls. | | | name | string | The name of the this multiple | | | tracking\_link | string | The tracking link url of the landing page | | | preview\_url | string | URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page. | | | conversion\_protocol | integer | The Conversion tracking method to use for the Offer. | | offer\_event | | | Volume based payout tiers of this offer. | | | event\_id | integer | Event id. | | | event\_name | string | Event name. | | | event\_payout\_type | string | Possible Values: CPC · CPI · CPM · CPA · CPL · CPS · CPA+CPS | | | event\_payout | string | Event payout. | | | event\_percent\_payout | string | Event percent payout. | | | conversion\_protocol | integer | The Conversion tracking method to use for the event. Possible Values: 1:Image Pixel; 2:Postback URL; 3:iFrame Pixel | | offer\_geo | | | | | | id | integer | | | | offer\_id | integer | A string that uniquely identifies this offer. | | | country | string | Country to be targeted. | | | country\_code | string | Country code. | | | city | array | **This parameter has been deprecated.** **\[Deprecated]** | | | type | integer | An identifier included or excluded. | | | regions | | Regions in targeted country | | | type | integer | An identifier included or excluded. Type: 1 include ; 2 exclude | | | region\_id | integer | the unique id for the region | | | region\_name | string | the name of the region | | | cities | | City in targeted Region | | | type | integer | An identifier included or excluded. Type: 1 include ; 2 exclude | | | region\_id | integer | the unique id for the region | | | city\_id | integer | the unique id for the city | | | city\_name | string | the name of the city | | offer\_platform | | | | | | id | integer | | | | offer\_id | integer | A string that uniquely identifies this offer. | | | platform | string | Devices to be targeted, it might be PC/Mobile/Tablet. | | | system | string | Operating System in Device. By default it allows all OS in targeted platform. | | | version | array | Version of the system. By default it allows all versions in targeted system. | | | ***is\_above*** | integer | A new field, is\_above, is added to offer platform to support upper compatibility in platform. When new platform versions are upgraded, the traffic won’t be rejected. Allowed values: 0 Close; 1 Open | | offer\_cap | | | | | | id | integer | | | | offer\_id | integer | A string that uniquely identifies this offer. | | | cap\_budget | string | | | | cap\_click | integer | | | | cap\_type | integer | Cap type: | | | cap\_conversion | integer | | | | category | integer | Category type: | | | cap\_timezone | string | Time zone. | | offer\_postback | | | | | | id | integer | Affiliate payout id. | | | offer\_id | integer | Offer id. | | | affiliate\_id | integer | Affiliaite id | | | event\_id | integer | Event id. | | | code | string | Code. | | | status | string | Status of Postback. Pending; Approved; rejected | | | type | string | Type of code. | | | create\_time | integer | Create time. | | | update\_time | integer | Update time. | | offer\_creative | | | | | | id | integer | The unique id for the creative. | | | offer\_id | integer | A string that uniquely identifies this offer. | | | url | string | Creative file download link. | | | mime | string | Types of creative documents. | | | size | integer | The size of the creative file. | | | width | integer | Width of creative file (image type). | | | height | integer | Height of creative file (image type). | | | totalPages | integer | The list of data pages (associated with your limit). | | | totalRows | integer | Total number of available data. | | | offset | integer | The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. | | | limit | integer | The number of data displayed on one page | ## Example request **Request GET** **Request GET** ## Example response ``` { "code": 0, "message": "Success", "data": { "rowset": [ { "offer": { "id": 290, "name": "offerslook", "category": "", "offer_approval": 1, "tracking_link": "No permissions visit this resource", "end_date": 1570118399, "pricing_type": "CPC", "payout": "53", "preview_url": "http://www.offerslook.com", "impression_pixel": "No permissions visit this resource", }, "offer_event": [ { "event_id": 1, "event_name": "Initial Event", "event_payout_type": "CPC", "event_payout": "53", "event_percent_payout": "-1", "conversion_protocol": 2 } ], "offer_geo": { "type": 1, "target": [ { "country": "China", "country_code": "CN", "id": 541393, "city": null, "type": null, "offer_id": null, "regions": [ { "type": 1, "region_id": 633, "region_name": "Anhui Sheng" }, { "type": 1, "region_id": 635, "region_name": "Beijing Shi" }, { "type": 1, "region_id": 641, "region_name": "Guangxi Zhuangzu Zizhiqu" } ], "cities": [ { "type": 1, "region_id": 633, "city_id": 97648, "city_name": "Anqing" }, { "type": 1, "region_id": 633, "city_id": 97649, "city_name": "Baiyin" }, { "type": 1, "region_id": 633, "city_id": 97651, "city_name": "Bozhou" }, { "type": 2, "region_id": 635, "city_id": 97739, "city_name": "Beijing" } ] }, { "country": "Albania", "country_code": "AL", "id": 541401, "city": null, "type": null, "offer_id": null, "regions": [], "cities": [] }, { "country": "Armenia", "country_code": "AM", "id": 541402, "city": null, "type": null, "offer_id": null, "regions": [], "cities": [] } ] }, "offer_platform": { "target": [ { "id": 1917, "offer_id": 290, "platform": "PC", "system": "", "version": [ ], "is_above": 1 }, { "id": 1918, "offer_id": 290, "platform": "Mobile", "system": "Android", "version": [ ], "is_above": 0 }, { "id": 1919, "offer_id": 290, "platform": "Mobile", "system": "iOS", "version": [ "5.1", "6.0", "6.1" ], "is_above": 1 } ] }, "offer_cap": { "id": 290, "offer_id": 290, "cap_type": 1, "cap_click": 2, "cap_conversion": 0, "cap_budget": "0", "category": null, "cap_timezone": "Australia/Lord_Howe" } }, { "offer": { "id": 91, "name": "test", "category": "", "offer_approval": 1, "tracking_link": "http://www.offerslook.com?offer_id=91&aff_id=161", "end_date": 1497715199, "pricing_type": "CPC", "payout": "2", "preview_url": "http://www.baidu.com", "impression_pixel": "", }, "offer_event": [ { "event_id": 1, "event_name": "Initial Event", "event_payout_type": "CPC", "event_payout": "2", "event_percent_payout": "-1", "conversion_protocol": 2 } ], "offer_geo": { "type": 1, "target": [ ] }, "offer_platform": { "target": [ ] }, "offer_cap": "" } ], "totalPages": 11, "totalRows": 21, "offset": 2, "limit": 2 } } ``` --- # 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://offerslook-api.gitbook.io/api-documentation/affiliate_api/offers/get-offers.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.