API Method – getOffers

    getOffers
    Get offer information.

API Category

    Offer

HTTP Method

    GET

Request Call Example

    HTTP:
    GET /api/v2/getOffers?key=yourapikey&page=1&limit=500&country=CN&status=Active HTTP/1.1
    Host: yourapplicationdomain
 
    Java:
    Unirest.get("http://yourapplicationdomain/api/v2/getOffers?key=yourapikey&page=1&limit=500&country=CN&status=Active").asString();

Parameters


Name Type Description
page Integer Page number of data
limit Integer Number of items on one page: 500(Default)/1000/5000/10000
from String Start date of creation time of offers: 2018/01/01
offer_ids String A list of offer ids: 3,123,445
advertiser_ids String A list of advertiser ids: 4,23,54
country String A list of countries of the offers: CN,US,CA,BD. Please refer to offer geo country list.
status String Offer status: Active/Pending/Expired/Paused/Archived
event_info Integer Return sub event info.
1: Returning sub event info
0 (Default): Not returning sub event info to save data size.
geo_info Integer Return geo targeting info.
1: Returning geo targeting info
0 (Default): Not returning geo targeting info to save data size.
device_info Integer Return device targeting info.
1: Returning device targeting info
0 (Default): Not returning device targeting info to save data size.
cap_info Integer Return cap info.
1: Returning cap info
0 (Default): Not returning cap info to save data size.
category_info Integer Return category info.
1: Returning category info
0 (Default): Not returning category info to save data size.
traffic_type_info Integer Return traffic type info.
1: Returning traffic type info
0 (Default): Not returning traffic type info to save data size.

Response

Offer Property Description
id Advertiser ID
first_name -
last_name -
status Advertiser Status
 
Sample in JSON:

{
    "httpStatus": 200,
    "errorCode": 0,
    "errorMessage": "",
    "message": "",
    "data": {
        "content": [
            {
                "id": "242",
                "name": "traffic_test_1",
                "app_id": "",
                "create_date": "2017/09/21",
                "expire_date": "2018/09/21",
                "status": "Active",
                "tracking_link": "http://network.fusetracking.com/tl?a=29&o=242",
                "type": "Mobile",
                "preview_url": "http://www.baidu.com",
                "currency": "Euro",
                "payout_type": "CPA+CPS",
                "logo": "",
                "screenshot": "",
                "description": "123",
                "restriction": "",
                "hide_referrer": "No",
                "geo_type": "Exclude",
                "geo_countries": "",
                "categories": [],
                "allow_traffics": [
                    {
                        "traffic_id": "1",
                        "traffic_name": "Banner/Displays"
                    },
                    {
                        "traffic_id": "2",
                        "traffic_name": "Email"
                    },
                    {
                        "traffic_id": "3",
                        "traffic_name": "Search PPC"
                    },
                    {
                        "traffic_id": "4",
                        "traffic_name": "Social Media"
                    },
                    {
                        "traffic_id": "5",
                        "traffic_name": "Social Ads"
                    },
                    {
                        "traffic_id": "6",
                        "traffic_name": "PPC"
                    },
                    {
                        "traffic_id": "7",
                        "traffic_name": "PPV/CPV"
                    },
                    {
                        "traffic_id": "8",
                        "traffic_name": "Classified Ads"
                    },
                    {
                        "traffic_id": "9",
                        "traffic_name": "Contextual"
                    },
                    {
                        "traffic_id": "10",
                        "traffic_name": "Co-Registration"
                    },
                    {
                        "traffic_id": "11",
                        "traffic_name": "Adult Traffic"
                    },
                    {
                        "traffic_id": "12",
                        "traffic_name": "SEO"
                    },
                    {
                        "traffic_id": "13",
                        "traffic_name": "Mobile"
                    },
                    {
                        "traffic_id": "14",
                        "traffic_name": "Incent"
                    },
                    {
                        "traffic_id": "15",
                        "traffic_name": "garyW"
                    }
                ],
                "geo_states": [],
                "device_rules": [],
                "has_cap_limit": "No",
                "cap_type": "",
                "cap_event_range": "all",
                "cap_affiliate_overall_limit": "Not Set",
                "cap_affiliate_interval": "Not Set",
                "cap_affiliate_interval_limit": "Not Set",
                "payout": "1.12345",
                "payout_percent": "10.1",
                "events": [
                    {
                        "e_id": "1",
                        "event_name": "InitialEvent",
                        "e_tkn": "",
                        "description": "123",
                        "payout_type": "CPA+CPS",
                        "payout": "1.12345",
                        "payout_percent": "10.1%",
                        "conversion_point": "DOI"
                    }
                ]
            }
        ],
        "page": 1,
        "totalPages": 1,
        "totalItems": 1
    }
}