API Method – getOverallReport

    getOverallReport
    Get overall report.

API Category

    Report

HTTP Method

    GET

Request Call Example

    HTTP:
    GET /api/v2/getOverallReport?key=yourapikey& from=2018/04/01 12&to=2018/04/09 12&timezone=8&page=1&limit=500&ck_offer_id=1&ck_offer_id=1&ck_offer_name=1&offer=3725082&ck_source=1&ck_cost=1&ck_income=1&ck_gross=1&ck_unique=1&ck_affiliate_id=1&ck_affiliate_name=1&ck_conversion=1&ck_offer_url=1&ck_advertiser_id=1&ck_advertiser_name=1&ck_profit=1&ck_cr=1&ck_cpc=1&ck_cpa=1&ck_rpc=1&ck_rpa=1&ck_roi=1&ck_day=1 HTTP/1.1
    Host: yournetworkapplicationdomain
 
    Java:
    Unirest.get("http://yournetworkapplicationdomain/api/v2/getOfferReport?key=yourapikey&from=2018/04/01%2012&to=2018/04/09%2012&timezone=8&page=1&limit=500&ck_offer_id=1&ck_offer_name=1&offer=3725082&ck_source=1&ck_cost=1&ck_income=1&ck_gross=1&ck_unique=1&ck_affiliate_id=1&ck_affiliate_name=1&ck_conversion=1&ck_offer_url=1&ck_advertiser_id=1&ck_advertiser_name=1&ck_profit=1&ck_cr=1&ck_cpc=1&ck_cpa=1&ck_rpc=1&ck_rpa=1&ck_roi=1&ck_day=1”).asString();

Parameters

Name Type Description
page* Integer Page number of report data
limit Integer Number of items on one page: 500(Default)/1000/5000/10000
timezone* Integer Filter – Timezone: -11 ~ 14
from* String Filter – Start time: YY/MM/DD or YY/MM/DD HH
to* String Filter – End time: YY/MM/DD or YY/MM/DD HH
advertiser String Filter – a list of offer ids: 3,123,445
offer String Filter – a list of offer ids: 3,123,445
affiliate String Filter – a list of affiliate ids: 3,123,445
event_range Integer Filter – Event Range: 0 – all events/1 – initial events
order String Order: ASC/DESC
orderBy String Order By: order by a response field flag
ck_offer_id Integer Response Field Flag – Offer id: 1 or 0, show this field or not
ck_offer_name Integer Response Field Flag – Offer name: 1 or 0, show this field or not
ck_advertiser_id Integer Response Field Flag – Advertiser id: 1 or 0, show this field or not
ck_advertiser_name Integer Response Field Flag – Advertiser name: 1 or 0, show this field or not
ck_affiliate_id Integer Response Field Flag – Affiliate id: 1 or 0, show this field or not
ck_affiliate_name Integer Response Field Flag – Affiliate: 1 or 0, show this field or not
ck_event_id Integer Response Field Flag – Event id: 1 or 0, show this field or not
ck_event_name Integer Response Field Flag – Event name: 1 or 0, show this field or not
ck_event_token Integer Response Field Flag – Event token: 1 or 0, show this field or not
ck_source_click Integer Response Field Flag – All clicks: 1 or 0, show this field or not
ck_gross Integer Response Field Flag – Gross clicks: 1 or 0, show this field or not
ck_unique Integer Response Field Flag – Unique clicks: 1 or 0, show this field or not
ck_conversion Integer Response Field Flag – Conversions: 1 or 0, show this field or not
ck_income Integer Response Field Flag – Income from Network: 1 or 0, show this field or not
ck_currency Integer Response Field Flag – Income currency: 1 or 0, show this field or not
ck_cr Integer Response Field Flag – Conversion Rate: 1 or 0, show this field or not
ck_cpc Integer Response Field Flag – Cost per click: 1 or 0, show this field or not
ck_cpa Integer Response Field Flag – Cost per action(conversion): 1 or 0, show this field or not
ck_rpc Integer Response Field Flag – Revenue per click: 1 or 0, show this field or not
ck_rpa Integer Response Field Flag – Revenue per action(conversion): 1 or 0, show this field or not
ck_roi Integer Response Field Flag – Revenue of investment: 1 or 0, show this field or not
ck_year Integer Show By Year: 1
ck_month Integer Show By Month: 1
ck_week Integer Show By Week: 1
ck_day Integer Show By Day: 1
ck_hour Integer Show By Hour: 1

Response

Sample in JSON:
{
    "httpStatus": 200,
    "data": {
        "page": "1",
        "totalPages": 1,
        "totalItems": 2,
        "content": [
            {
                "ck_day": "2018/04/11",
                "ck_affiliate_id": 5,
                "ck_affiliate_name": "Mike Mikaelson",
                "ck_offer_id": 293,
                "ck_offer_name": "Offer_18477_ModifiedAt1497437029441",
                "ck_advertiser_id": 1,
                "ck_advertiser_name": "Martin Wilson",
                "ck_gross": 1,
                "ck_unique": 1,
                "ck_conversion": 1,
                "ck_cost": "1.12350",
                "ck_income": "2.23460",
                "ck_profit": "1.11110",
                "ck_cr": "100.00",
                "ck_cpc": "1.1235",
                "ck_cpa": "1.1235",
                "ck_rpc": "2.2346",
                "ck_rpa": "2.2346",
                "ck_roi": "98.90",
                "currency": "€ ",
                "offer_id": 293,
                "affiliate_id": 5,
                "advertiser_id": 1
            },
            {
                "ck_day": "2018/04/11",
                "ck_affiliate_id": 5,
                "ck_affiliate_name": "Mike Mikaelson",
                "ck_offer_id": 295,
                "ck_offer_name": "ugly370",
                "ck_advertiser_id": 50,
                "ck_advertiser_name": "aaaa ",
                "ck_gross": 1,
                "ck_unique": 1,
                "ck_conversion": 1,
                "ck_cost": "5.00000",
                "ck_income": "1.00000",
                "ck_profit": "-4.00000",
                "ck_cr": "100.00",
                "ck_cpc": "5.0000",
                "ck_cpa": "5.0000",
                "ck_rpc": "1.0000",
                "ck_rpa": "1.0000",
                "ck_roi": "-80.00",
                "currency": "$",
                "offer_id": 295,
                "affiliate_id": 5,
                "advertiser_id": 50
            }
        ]
    },
    "errorCode": 0,
    "message": ""
}