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 · RPA · RPS · RPA+RPS
Values of "RPC" 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 · CPS · CPA+CPS
Values of "CPC" 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” 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
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.
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
offer_id integer This parameter has been deprecated.
[Deprecated]
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.
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.
cap_budget string This parameter has been deprecated.
[Deprecated]
cap_click integer This parameter has been deprecated.
[Deprecated]
cap_type integer This parameter has been deprecated.
[Deprecated]
cap_conversion integer This parameter has been deprecated.
[Deprecated]
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.
email 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


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


Example response

{
    "code": 0,
    "message": "Success",
    "data": {
        "offer": {
            "id": 102,
            "name": "Fiver Android 12Geos(Capped)",
            "advertiser_id": 324,
            "start_date": 1563258276,
            "end_date": 1582970399,
            "status": "active",
            "offer_approval": 2,
            "revenue_type": "RPS",
            "revenue": "0",
            "percent_revenue": 8.88,
            "payout_type": "CPS",
            "payout": "0",
            "percent_payout": 8.88,
            "preview_url": "https://play.google.com/store/apps/details?id=com.fiverr.fiverr",
            "destination_url": "http://guoqoqo.iuniontrack.com:9080/index.php?offer_id=803&aff_id=2",
            "description": "<p>Campaign details: Campaign Name: Fiverr - Freelance Services ? US, UK, AU, CA, DE, NL, SG, FR, ZA, ROW, SA, RU. Flight dates: ASAP OS: iOS 10.0 and up Android: 4.1 and up Preview link: Android https://play.google.com/store/apps/details?id=com.fiverr.fiverr iOS https://itunes.apple.com/au/app/id346080608 Traffic: Non-Incent Geo: US, UK, AU, CA, DE, NL, SG, FR, ZA, ROW (WW), SA, RU. KPI Goal: CPE Campaign - postback will be fire on FTB (First Time Buyer) Traffic restrictions: no incentive, no adult, no brand biding (not allowed to use Fiverr as a keyword).</p>\r\n<p><strong>Kpi</strong> :</p>",
            "redirect_offer_id": 0,
            "currency": "USD",
            "conversion_protocol": 2,
            "is_ssl": 0,
            "approve_conversions": 0,
            "unique_click_ip_count": 0,
            "tracking_domain": "qoqololo.iuniontrack.com:9080",
            "lead_traffic": 0,
            "hide_referral": 0,
            "advertiser_offer_id": "803",
            "app_id": "",
            "impression_status": 0,
            "impression_url": ""
        },
        "advertiser": {
            "id": 324,
            "offer_id": 478368,
            "email": "qoqotest@test.com",
            "first_name": "advertiser",
            "last_name": "test",
            "country": "Burkina Faso",
            "status": "active",
            "website": "http://www.baidu.com",
            "create_time": 1520414341,
            "company": "oooooo",
            "phone": "+1(112)222-3333",
            "manager_id": 7,
            "instant_message_type": 3,
            "instant_message_account": "test@facebook.com",
            "security_mode": 1,
            "security_code": "fdbf57c6882b4f258b8548012b1c46b6"
        },
        "offer_geo": {
            "type": 1,
            "target": [
                {
                    "country": "China",
                    "country_code": "CN",
                    "id": 541446,
                    "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": 1,
                            "region_id": 633,
                            "city_id": 97658,
                            "city_name": "Diaoshi Township"
                        },
                        {
                            "type": 2,
                            "region_id": 635,
                            "city_id": 97739,
                            "city_name": "Beijing"
                        }
                    ]
                }
            ]
        },
        "offer_cap": {
            "id": 478368,
            "offer_id": 478368,
            "adv_cap_type": 0,
            "adv_cap_click": 0,
            "adv_cap_conversion": 0,
            "adv_cap_revenue": "0",
            "aff_cap_type": 0,
            "aff_cap_click": 0,
            "aff_cap_conversion": 0,
            "aff_cap_payout": "0",
            "cap_timezone": "Asia/Colombo"
        },
        "offer_category": [
            {
                "id": 351,
                "name": "Apps",
                "create_time": 1517896459,
                "offer_id": 478368
            }
        ],
        "offer_platform": {
            "target": []
        }
    }
}

results matching ""

    No results matching ""