Get information about a specific offer

HTTP method Endpoint
GET /v1/offers/{offer_id}

Path parameters

Parameter Description
offer_id The unique id for the offer.

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.
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 · RPI · RPS · RPA+RPS
Values of "RPC" 、“RPI”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”, “RPA” 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 · CPA · CPI · CPS · CPA+CPS
Values of "CPC" ,“CPI”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” 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.
push_allowed integer [Deprecated]
incent_allowed integer [Deprecated]
adult_allowed integer [Deprecated]
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 [Deprecated]
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.
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.
tracking_domain string multipul custom domain
lead_traffic integer 1=Enabled ,
2=Disabled
advertiser_offer_id string advertiser offer id
app_id string the App ID on app store or google play
hide_referral integer 1=Enabled ,
2=Disabled
impression_status string 1=Enabled ,
2=Disabled
impression_url string The Impression Offer URL where Impression Pixel will be redirected to

Example request

Request GET https://{networkname}.api.offerslook.com/v1/offers/102


Request GET http://{networkname}.api.offerslook.com/v1/offers/102


Example response


    {
      "code": 0,
      "message": "Success",
      "data": {
        "offer": {
          "id": 102,
          "name": "test",
          "advertiser_id": 5401,
          "start_date": 1480174200,
          "end_date": 1528385399,
          "status": "active",
          "offer_approval": 1,
          "pricing_type": "Parameter deprecation. Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.",
          "revenue_type": "RPA",
          "revenue": "21",
          "percent_revenue": "-1",
          "payout_type": "CPC",
          "payout": "21",
          "percent_payout": "-1",
          "preview_url": "http://www.offerslook.com",
          "destination_url": "http://www.offerslook.com",
          "description": "<p>This is our company's website address: http://www.offerslook.com.Welcome to visit!</p>",
          "push_allowed": null,
          "incent_allowed": null,
          "adult_allowed": null,
          "redirect_offer_id": 3,
          "global_redirect_enabled": null,
          "currency": "USD",
          "conversion_protocol": 1,
          "is_ssl": 1,
          "approve_conversions": 0,
          "unique_click_ip_count": 0,
          "lead_traffic": 0,
          "hide_referral": 1,
          "advertiser_offer_id": "555",
          "app_id": "346328468",
          "impression_status": 0,
          "impression_url": "http://www.offerslook.com"

        }
      }
    }

results matching ""

    No results matching ""