Get all information about a specific offer
HTTP method | Endpoint |
GET | /v1/offers/{offer_id}/all |
Path parameters
Parameter | Description |
offer_id | The unique id 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. 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", "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 | |
tracking_domain | string | the domain to generate offer tracking link and postback | |
is_ssl | integer | Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http. Allowed values: 0 Close; 1 Open | |
approve_conversions | integer | Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Allowed values: 0 Close; 1 Open | |
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. | |
carrier_mode | integer | carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude. | |
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_geo | |||
id | integer | ||
country | string | Country to be targeted. | |
country_code | string | Country code. | |
type | integer | An identifier included or excluded. Type: 1 include ; 2 exclude | |
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_category | |||
id | integer | ||
offer_id | integer | A string that uniquely identifies this offer. | |
name | array | Types | |
create_time | string | Create time for classification. | |
offer_cap | |||
id | integer | ||
offer_id | A string that uniquely identifies this offer. | ||
adv_cap_type | integer | Cap type: 0 none 1 total_count 2 daily_count 3 revenue | |
adv_cap_click | integer | Advertiser cap click limit. | |
adv_cap_conversion | integer | Advertiser cap conversion limit. | |
adv_cap_revenue | string | Advertiser cap revenue limit. | |
aff_cap_type | integer | Cap type: 0 none 1 total_count 2 daily_count 3 payout | |
aff_cap_click | integer | Affiliate cap click limit. | |
aff_cap_conversion | integer | Affiliate cap conversion limit. | |
aff_cap_payout | string | Affiliate cap payout limit. | |
cap_timezone | string | ||
offer_advertiser | |||
id | integer | Avertiser’s id. | |
offer_id | integer | Offer id. | |
first_name | string | The first_name of the this Advertiser. | |
last_name | string | The last_name of the this Advertiser. | |
string | The email of the this Advertiser. | ||
company | string | The company of the this Advertiser. | |
country | string | The country of the Advertiser's physical address. | |
status | string | The status of the Advertiser. | |
instant_message_account | string | Instant messaging account. | |
instant_message_type | integer | Types of instant messaging. | |
manager_id | integer | Account Manager ID | |
phone | string | The phone number of the Advertiser. | |
website | string | ||
conversion_security_code | integer | Selection to activate security code. | |
conversion_security_token | string | A string returned after conversion_security_code is turned on. |
Example request
Request GET https://{networkname}.api.offerslook.com/v1/offers/102/all
Example response
Last updated