Get all offers

HTTP method	Endpoint
GET	/v1/offers

Get all offers in a network.

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 = 1000
Sort	sort	sort	Ranking according to the specified field ascending "+", or descending "-".
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
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.
	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 · RPI · RPM · RPS · RPA+RPS Values of "RPC", "RPI", "RPM", "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”, "CPI", "CPM", “CPA”, "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

Response body parameters

Field	Type	Description
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	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", "RPI", "RPM", "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", "CPM", "CPI", "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”, "CPM", "CPI", “CPA”, "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
carrier_mode	integer	carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude.
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
carrier	array	Mobile Carrier
offer_url	array
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/offers?sort=+id&offset=2&limit=8&filters[id][GREATER_THAN]=20

Example response

    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "id": 29,
            "name": "Sunday",
            "end_date": 1484409599,
            "status": "active",
            "revenue_type": "RPC",
            "revenue": "30",
            "percent_revenue": "-1",
            "payout_type": "CPA",
            "payout": "54",
            "percent_payout": "-1"
          },
          {
            "id": 30,
            "name": "This is a test",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "10",
            "percent_revenue": "10",
            "payout_type": "CPA",
            "payout": "54",
            "percent_payout": "-1"
          },
          {
            "id": 31,
            "name": "Sundy",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          },
          {
            "id": 32,
            "name": "sun",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          },
          {
            "id": 33,
            "name": "rule",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          },
          {
            "id": 34,
            "name": "test",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          },
          {
            "id": 35,
            "name": "demo",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          },
          {
            "id": 36,
            "name": "One day",
            "end_date": 1494345599,
            "status": "active",
            "revenue_type": "RPA+RPS",
            "revenue": "30",
            "percent_revenue": "10",
            "payout_type": "CPA+CPS",
            "payout": "24",
            "percent_payout": "10"
          }
        ],
        "totalPages": 18,
        "totalRows": 137,
        "offset": 2,
        "limit": 8
      }
    }