Get Offers

HTTP method	Endpoint
GET	/v1/batches/offers

Query string parameters

Conditions	Parameters	Type	Description
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 "-".
Fields	fields	field	You can choose the field of the query (the result of the query is in line with the selected field).
	id	integer	A string that uniquely identifies this offer.
	name	string	The name of the this Offer
	advertiser_id	integer	The ID of the Advertiser this Offer is for, if applicable
	start_date	integer	The activation date of the Offer.
	end_date	integer	The expiration date of the Offer.
	status	string	The current status of the offer. Possible Values: active·paused·pending·deleted
	offer_approval	integer	Whether this Offer requires manual approval before an Affiliate can run it. Possible Values: 1 Require Approval 2 Public 3 Private
	pricing_type	string	Parameter deprecation. Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.
	revenue_type	string	Specifies the method of calculating revenues for this Offer. Allowed values: RPC · RPI · RPM · RPA · RPL · RPS · RPA+RPS Values of "RPC", "RPM", “RPI”,"RPL" and "RPA" indicate a flat revenue amount, which is specified in the revenue field. Value of "RPS " indicates revenue is a percentage of sale, which is specified in the percent_revenue field. Value of "RPA+RPS " indicates both a flat revenue amount and a percentage of sale revenue.
	revenue	string	The flat rate/amount revenue. This is applicable depending on the "revenue_type " of the Offer. Applicable only if revenue_type is “RPC”, "RPM", "RPI",“RPA”, "RPL" or “RPA+RPS”.
	percent_revenue	string	Percentage of sale revenue for offer. Applicable only if revenue_type is “RPS” or “RPA+RPS”.
	payout_type	string	Offer's payout type. Allowed values: CPC · CPI · CPM · CPA · CPL · CPS · CPA+CPS Values of "CPC", "CPI", "CPM", "CPL"and "CPA" indicate a flat payout amount, which is specified in the payout field. Value of "CPS " indicates payout is a percentage of sale, which is specified in the percent_payout field. Value of "CPA+CPS " indicates both a flat payout amount and a percentage of sale payout.
	payout	string	The flat rate/amount paid for this Offer. Applicable for Offers whose "payout_type" includes a flat rate component. Applicable only if payout_type is “CPC”, “CPI”, “CPA”, "CPM", "CPL" or “CPA+CPS”.
	percent_payout	string	Percentage of sale payout for offer. Applicable only if payout_type is “CPS” or “CPA+CPS”.
	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.
	destination_url	string	The default Offer URL where traffic will be redirected to. Several optional variables/macros can be included in an Offer URL.
	description	string	A description for the Offer.
	redirect_offer_id	integer	The ID of another Offer to redirect traffic to if the offer has exceeded its conversion cap or the Offer is paused.
	currency	string	The currency of the Offer.
	conversion_protocol	integer	The Conversion tracking method to use for the Offer. Possible values: 1 Image Pixel 2 Postback URL 3 iFrame Pixel
	is_ssl	integer	Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http. Possible values: 1 Open 0 Close
	approve_conversions	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Possible values: 1 Open 0 Close
	unique_click_ip_count	integer	Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
	advertiser_offer_id	string	advertiser offer id
	app_id	string	the App ID on app store or google play
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 CONTAINS NOT_CONTAINS NULL NOT_NULL
	unique_click_ip_count	integer	Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
	create_time	integer	Create time.
	update_time	integer	Update time.
	id	integer	A string that uniquely identifies this offer.
	name	string	The name of the this Offer
	advertiser_id	integer	The ID of the Advertiser this Offer is for, if applicable
	start_date	integer	The activation date of the Offer.
	end_date	integer	The expiration date of the Offer.
	status	string	The current status of the offer. Possible Values: active·paused·pending·deleted
	offer_approval	integer	Whether this Offer requires manual approval before an Affiliate can run it. Possible Values: 1 Require Approval 2 Public 3 Private
	pricing_type	string	Parameter deprecation. Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.
	revenue_type	string	Specifies the method of calculating revenues for this Offer. Allowed values: RPC · RPA · RPL · RPM · RPI · RPS · RPA+RPS Values of "RPC" ,"RPM", "RPI", "RPL" and "RPA" indicate a flat revenue amount, which is specified in the revenue field. Value of "RPS " indicates revenue is a percentage of sale, which is specified in the percent_revenue field. Value of "RPA+RPS " indicates both a flat revenue amount and a percentage of sale revenue.
	revenue	string	The flat rate/amount revenue. This is applicable depending on the "revenue_type " of the Offer. Applicable only if revenue_type is “RPC”, "RPI", "RPM", “RPA”, "RPL" or “RPA+RPS”.
	percent_revenue	string	Percentage of sale revenue for offer. Applicable only if revenue_type is “RPS” or “RPA+RPS”.
	payout_type	string	Offer's payout type. Allowed values: CPC · CPI · CPM · CPA · CPL · CPS · CPA+CPS Values of "CPC", “CPI”, "CPM", "CPL" and "CPA" indicate a flat payout amount, which is specified in the payout field. Value of "CPS " indicates payout is a percentage of sale, which is specified in the percent_payout field. Value of "CPA+CPS " indicates both a flat payout amount and a percentage of sale payout.
	payout	string	The flat rate/amount paid for this Offer. Applicable for Offers whose "payout_type" includes a flat rate component. Applicable only if payout_type is “CPC”, “CPA”, "CPI", "CPM", "CPL" or “CPA+CPS”.
	percent_payout	string	Percentage of sale payout for offer. Applicable only if payout_type is “CPS” or “CPA+CPS”.
	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.
	destination_url	string	The default Offer URL where traffic will be redirected to. Several optional variables/macros can be included in an Offer URL.
	description	string	A description for the Offer.
	redirect_offer_id	integer	The ID of another Offer to redirect traffic to if the offer has exceeded its conversion cap or the Offer is paused.
	currency	string	The currency of the Offer.
	conversion_protocol	integer	The Conversion tracking method to use for the Offer. Possible values: 1 Image Pixel 2 Postback URL 3 iFrame Pixel
	is_ssl	integer	Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http. Possible values: 1 Open 0 Close
	approve_conversions	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Possible values: 1 Open 0 Close
	unique_click_ip_count	integer	Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
	create_time	integer	Create time.
	update_time	integer	Update time.
	geo_country	string	Only support the following ways, EQUAL_TO,NOT_EQUAL_TO,CONTAINS and NOT_CONTAINS. For example,filters[geo_country][EQUAL_TO]=CN,India,GB
	category	string	Only support the following ways, EQUAL_TO,NOT_EQUAL_TO,CONTAINS and NOT_CONTAINS. For example,filters[category][EQUAL_TO]=test,tool
	platform	string	Only support the following ways, EQUAL_TO,NOT_EQUAL_TO,CONTAINS and NOT_CONTAINS. For example,filters[platform][CONTAINS]=PC
	platform_system	string	Only support the following ways, EQUAL_TO,NOT_EQUAL_TO,CONTAINS and NOT_CONTAINS. For example,filters[platform_system][CONTAINS]=android
Contains	contains	string	List of related objects to return with each result.
	offer	string	Offer information (default return)
	offer_geo	string	Geo targeted by the offer.
	offer_partform	string	Platforms targeted by the offer.
	offer_category	string	Offer categories associated with the offer.
	offer_cap	string	Offer caps defined for the offer.
	offer_event	string	Offer events defined for the offer.
	offer_thumbnail	string	Thumbnail image.
	offer_creative	string	Offer creatives associated with the offer.
	offer_pool	string	Offer pool associated with the offer.
	approved_affiliate	string	Approved affiliate associated with the offer.
	blocked_affiliate	string	Blocked affiliate associated with the offer.
	offer_task	string	Offer task defined for the offer.

Response body parameters

	Field	Type	Description
offer
	id	integer	A string that uniquely identifies this offer.
	name	string	The name of the this Offer
	advertiser_id	integer	The ID of the Advertiser this Offer is for, if applicable
	start_date	integer	The activation date of the Offer.
	end_date	integer	The expiration date of the Offer.
	status	string	The current status of the offer.
	offer_approval	integer	Whether this Offer requires manual approval before an Affiliate can run it.
	pricing_type	string	The current pricing_type of the offer.
	revenue	string	The flat rate/amount revenue. This is applicable depending on the "pricing_type" of the Offer. The default currency is US dollar.
	payout	string	Offer 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.
	destination_url	string	The default Offer URL where traffic will be redirected to. Several optional variables/macros can be included in an Offer URL.
	description	string	A description for the Offer.
	redirect_offer_id	integer	The ID of another Offer to redirect traffic to if the offer has exceeded its conversion cap or the Offer is paused.
	global_redirect_enabled	integer	Whether this Offer has Goals enabled.
	currency	string	The currency of the Offer.
	conversion_protocol	integer	The Conversion tracking method to use for the Offer.
	is_ssl	integer	Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http.
	approve_conversions	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated.
	unique_click_ip_count	integer	Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
	create_time	integer	Create time.
	update_time	integer	Update time.
	advertiser_offer_id	string	advertiser offer id
	app_id	string	the App ID on app store or google play
	carrier_mode	integer	carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude.
offer_geo
	id	integer
	country	string	Country to be targeted.
	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
	ttype	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_category
	id	integer
	offer_id	integer	A string that uniquely identifies this offer.
	name	array	Types
	create_time	integer	Create time.
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
	cap_timezone	string	Timezone selected.
offer_event
	id	integer	The unique id for the event.
	name	string	Offer Event name.
	revenue	string	Event revenue.
	payout	string	Event payout.
	status	string	The status of the event.
	is_private	integer	Enabling this setting will track revenue of event only, affiliate do not have access to private events, custom affiliate payouts can not be set nor can 3rd party affiliate postbacks be placed.
	approve_conversion	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated.
	is_allowed_multiple	integer	Enabling this setting will allow multiple conversions to be recorded per user for only one click id.
	is_end_point	integer	Enabling this setting will close the active click session when this event is converted.
	conversion_protocol	integer	The Conversion tracking method to use for the offer event.
	event_postback	string	Postback URL.
	offer_payout_tier
	tier_id	integer	The unique id for the tier.
	tier_payout	string	Tier payout.
	create_time	integer	Create time.
	update_time	integer	Update time.
offer_thumbnail
	id	integer	A string that uniquely identifies this thumbnail.
	offer_id	integer	A string that uniquely identifies this offer.
	url	string	The url of the thumbnail preview.
	mime	string	The type of the thumbnail.
	size	integer	The size of the file in bytes.
	width	integer	The width of the image.
	height	integer	The height of the image.
	filename	string	The name of the file that was uploaded, optionally passed in.
offer_creative
	id	integer	A string that uniquely identifies this creative.
	offer_id	integer	A string that uniquely identifies this offer.
	url	string	The url of the creative preview.
	mime	string	The type of the creative.
	size	integer	The size of the file in bytes.
	width	integer	The width of the image.
	height	integer	The height of the image.
	filename	string	The name of the file that was uploaded, optionally passed in.
offer_pool
	offer_pool	integer	Pool id.
approved_affiliate
	affiliate_id	integer	Affiliate id.
	tracking_link	string	Tracking link
	affiliate_cap
	id	integer
	offer_id	integer	Offer id.
	affiliate_id	integer	Affiliate id.
	cap_budget	string
	cap_click	integer
	cap_type	integer	Cap type.
	cap_conversion	integer
	category	integer	The type of code.
	create_time	integer	Create time,
blocked_affilaite
	blocked_affiliate	integer	Affiliate id.
offer_task
	id	integer
	offer_id	integer	A string that uniquely identifies this offer.
	user_id	integer	Founder ID (manager ID).
	modify_status	string	Set status for task: active or paused.
	execute_time	string	Execute time.
	create_time	string	Create time.
	update_time	string	Update time.
	complete_status	integer	Complete status：0: uncompleted ;1: completed
	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 https://{networkname}.api.offerslook.com/v1/batches/offers?sort=-id&limit=2&offset=1&filters[status]=active&filters[geo_country][EQUAL_TO]=CN,Albania&filters[id][EQUAL_TO]=102

Example response

    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "offer": {
              "id": 102,
              "name": "test",
              "advertiser_id": 147,
              "status": "active",
              "revenue_type": "RPA+RPS",
              "revenue": "10",
              "percent_revenue": "10",
              "payout_type": "CPA+CPS",
              "payout": "7",
              "percent_payout": "10",
              "currency": "EUR",
              "preview_url": "https://www.offerslook.com/affiliate/goto_offer/388/309/{click_id}",
              "destination_url": "https://https://www.offerslook.com/affiliate/goto_offer/388/309/{click_id}?click_id={click_id}&adv_id=147&event_id=1&security_code=0601fb9f82e8bb4c0b02d0eb4b8e28a8",
              "end_date": 1488297599
            },
                  "offer_geo": {
                    "type": 1,
                    "target": [
                        {
                            "country": "China",
                            "country_code": "CN",
                            "id": 541628,
                            "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": 541636,
                            "city": null,
                            "type": null,
                            "offer_id": null,
                            "regions": [],
                            "cities": []
                        },
                        {
                            "country": "Armenia",
                            "country_code": "AM",
                            "id": 541637,
                            "city": null,
                            "type": null,
                            "offer_id": null,
                            "regions": [],
                            "cities": []
                        }
                    ]
                },
            "offer_cap": {
              "id": 102,
              "offer_id": 102,
              "cap_budget": null,
              "cap_click": null,
              "cap_type": null,
              "cap_conversion": null,
              "adv_cap_type": 0,
              "adv_cap_click": 0,
              "adv_cap_conversion": 0,
              "adv_cap_revenue": "0",
              "aff_cap_type": 1,
              "aff_cap_click": 100,
              "aff_cap_conversion": 0,
              "aff_cap_payout": "0.000",
              "cap_timezone": "Asia/Hong_Kong"
            },
            "offer_event": [
              {
                "id": 1,
                "offer_id": 102,
                "name": "Initial Event",
                "revenue_type": "RPA+RPS",
                "revenue": "10.000",
                "percent_revenue": "10.00",
                "payout_type": "CPA+CPS",
                "payout": "7.000",
                "percent_payout": "10.00",
                "status": "active",
                "conversion_protocol": 2,
                "event_postback": "http://www.offerslook.com?click_id={click_id}&adv_id=147&event_id=1",
                "is_private": 0,
                "approve_conversions": 0,
                "is_allowed_multiple": 0,
                "is_end_point": 0,
                "offer_payout_tier": [
                  {
                    "tier_id": 11,
                    "offer_id": 102,
                    "event_id": 1,
                    "tier_payout": "1",
                    "tier_percent_payout": "2.00"
                  },
                  {
                    "tier_id": 12,
                    "offer_id": 102,
                    "event_id": 1,
                    "tier_payout": "2",
                    "tier_percent_payout": "2.00"
                  }
                ],
                "create_time": 0,
                "update_time": 0
              },
              {
                "id": 2,
                "offer_id": 102,
                "name": "test",
                "revenue_type": "RPA+RPS",
                "revenue": "10.000",
                "percent_revenue": "10.00",
                "payout_type": "CPA+CPS",
                "payout": "7.000",
                "percent_payout": "10.00",
                "status": "active",
                "conversion_protocol": 3,
                "event_postback": "<iframe src=\"http://www.offerslook.com?type=2&offer_id=102&adv_id=147&event_id=2\" scrolling=\"no\" frameborder=\"0\" width=\"1\" height=\"1\"></iframe>",
                "is_private": 0,
                "approve_conversions": 0,
                "is_allowed_multiple": 0,
                "is_end_point": 0,
                "offer_payout_tier": null,
                "create_time": 0,
                "update_time": 0
              }
            ],
            "approved_affiliate": [
              {
                "affiliate_id": 161,
                "tracking_link": "http://www.offerslook.com/index.php?offer_id=102&aff_id=161",
                "affiliate_cap": {
                  "id": 185,
                  "affiliate_id": 161,
                  "offer_id": 102,
                  "cap_type": 1,
                  "cap_click": 0,
                  "cap_conversion": 2,
                  "cap_budget": "0",
                  "category": 1,
                  "create_time": 1484646507
                }
              },
              {
                "affiliate_id": 188,
                "tracking_link": "http://www.offerslook.com?offer_id=102&aff_id=188",
                "affiliate_cap": null
              },
              {
                "affiliate_id": 191,
                "tracking_link": "http://www.offerslook.com?offer_id=102&aff_id=191",
                "affiliate_cap": {
                  "id": 186,
                  "affiliate_id": 191,
                  "offer_id": 102,
                  "cap_type": 3,
                  "cap_click": 0,
                  "cap_conversion": 0,
                  "cap_budget": "2",
                  "category": 2,
                  "create_time": 1484646571
                }
              }
            ]
          }
        ],
        "totalPages": 1,
        "totalRows": 1,
        "offset": 1,
        "limit": 2
      }
    }