1.1.1 Summary

Get Affiliate Offer Report.
 

1.1.2 Request

Request Method: GET
 
Parameters:

Parameter Description Type Data Range
key Network API Key;
*Required
string  
a Affiliate ID
*Required
Int  
Query Conditions
from Query Period Start Date
*Required
If the format is YYYY/MM/DD,  equal to YYYY/MM/DD 00.
Date YYYY/MM/DD  or
YYYY/MM/DD HH
to Query Period End Date
*Required
If the format is YYYY/MM/DD,  equal to YYYY/MM/DD 23.
Date YYYY/MM/DD  or
YYYY/MM/DD HH
timezone Timezone
*Required
Int -11 ~ 14
page Page Number
*Required
Int Positive integer greater than 0.
(10,000 records per page)
offer Offer ID Int Multi-select, separated by commas
currency Offer Currency Int 1~68
Multi-select, separated by commas
country Click GEO Country String Multi-select, separated by commas
e.g. “CN, US”
event_range Event Range Int 0: All Event
1: Initial Event(Default)
 
order Order String ASC
DESC
orderBy Order By Field
Default: ck_offer_id
String  
Response Field Flag
ck_offer_id
 
Offer ID Int 0: No this field.
1: include this field.
ck_offer_name Offer Name Int 0: No this field.
1: include this field.
ck_offer_url Offer URL Int 0: No this field.
1: include this field.
ck_currency Currency Int 0: No this field.
1: include this field.
ck_click_country Click GEO Country Int 0: No this field.
1: include this field.
ck_source Traffic Source Int 0: No this field.
1: include this field.
ck_sub1 Sub ID 1 Int 0: No this field.
1: include this field.
ck_sub2 Sub ID 2 Int 0: No this field.
1: include this field.
ck_sub3 Sub ID 3 Int 0: No this field.
1: include this field.
ck_sub4 Sub ID 4 Int 0: No this field.
1: include this field.
ck_sub5 Sub ID 5 Int 0: No this field.
1: include this field.
ck_type Device Type Int 0: No this field.
1: include this field.
ck_brand Device Brand Int 0: No this field.
1: include this field.
ck_model Device Model Int 0: No this field.
1: include this field.
ck_os Device OS Int 0: No this field.
1: include this field.
ck_browser Device Browser Int 0: No this field.
1: include this field.
ck_event_id Offer Event Id Int 0: No this field.
1: include this field.
 
ck_event_name Offer Event Name Int 0: No this field.
1: include this field.
 
ck_event_tkn Offer Event Token Int 0: No this field.
1: include this field.
 
ck_gross Gross Click Count Int 0: No this field.
1: include this field.
ck_unique Unique Click Count Int 0: No this field.
1: include this field.
ck_conversion Conversion Count Int 0: No this field.
1: include this field.
ck_cost Payout Summary Int 0: No this field.
1: include this field.
ck_cr CR Int 0: No this field.
1: include this field.
ck_cpc CPC Int 0: No this field.
1: include this field.
ck_year Group Data by Year Int 0: No this field.
1: include this field.
ck_month Group Data by Month Int 0: No this field.
1: include this field.
ck_week Group Data by Week Int 0: No this field.
1: include this field.
ck_day Group Data by Day Int 0: No this field.
1: include this field.
ck_hour Group Data by Hour Int 0: No this field.
1: include this field.
ck_source_click All Click Int 0: No this field.
1: include this field.
 

1.1.3 Response

 
Header:

HTTP Status Object Description Error Code
200   OK 0
400 Parameter Invalid Parameters 65XX
 
Content Format: JSON
 

Data Field Type
content Array of Report Data Item in Current Page
page Current Page Number
totalPages Total  Pages Count
totalItems Total Data Items Count
 

1.1.4 Example

Sample Request URL:
http://demo.fuseclick.com/api/v1/getOfferReport?key=603E3F0E3266&timezone=8&from=2015/01/01&to=2015/10/31&ck_offer_id=1
 
Response sample:

{
  "httpStatus": 200,
  "data": {
    "content": [
      {
        "offer_id": "3",
        "ck_offer_id": "3",
        "ck_gross": 3,
        "currency": "€ "
      },
      {
        "offer_id": "4",
        "ck_offer_id": "4",
        "ck_gross": 21,
        "currency": "€ "
      },
      {
        "offer_id": "4",
        "ck_offer_id": "4",
        "ck_gross": 2,
        "currency": "€ "
      },
      {
        "offer_id": "1",
        "ck_offer_id": "1",
        "ck_gross": 4,
        "currency": "€ "
      },
      {
        "offer_id": "1",
        "ck_offer_id": "1",
        "ck_gross": 8,
        "currency": "€ "
      },
      {
       "offer_id": "1",
        "ck_offer_id": "1",
        "ck_gross": 12,
        "currency": "€ "
      },
      {
        "offer_id": "4",
        "ck_offer_id": "4",
        "ck_gross": 11,
        "currency": "€ "
      }
    ],
    "page": 1,
    "totalPages": 1,
    "totalItems": 7
  },
  "errorCode": 0,
  "message": ""
}