getConversionReport
1.1.1 Summary
Get Conversion Report.
1.1.2 Request
Request Method: GET
Parameters:
Parameters:
Parameter
|
Description
|
Type
|
Data Range
|
key
|
Network API Key;
*Required |
string
|
|
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) |
affiliate
|
Affiliate ID
|
Int
|
Multi-select, separated by commas
|
advertiser
|
Advertiser ID
|
Int
|
Multi-select, separated by commas
|
click_country
|
Click GEO Country
|
String
|
Multi-select, separated by commas
e.g. “CN, US” |
offer
|
Offer ID
|
Int
|
Multi-select, separated by commas
|
currency
|
Offer Currency
|
Int
|
1~68
Multi-select, separated by commas |
category
|
Offer Category ID
|
Int
|
Multi-select, separated by commas
|
browser
|
Device Browser
|
String
|
chrome,
firefox, opera, safari Multi-select, separated by commas |
event_range
|
Event Range
|
Int
|
0: All Event
1: Initial Event(Default) |
status
|
Conversion Status
|
Int
|
1: Pending
2: Approved 4:Rejected Multi-select, separated by commas |
order
|
Order
|
String
|
ASC
DESC |
orderBy
|
Order By Field
Default: ck_advertiser_name |
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
|
Offe URL
|
Int
|
0: No this field.
1: include this field. |
ck_currency
|
Offer Currency
|
Int
|
0: No this field.
1: include this field. |
ck_advertiser_id
|
Advertiser ID
|
Int
|
0: No this field.
1: include this field. |
ck_advertiser_name
|
Advertiser Name
|
Int
|
0: No this field.
1: include this field. |
ck_advertiser_manager
|
Advertiser Manager
|
Int
|
0: No this field.
1: include this field. |
ck_affiliate_id
|
Affiliate ID
|
Int
|
0: No this field.
1: include this field. |
ck_affiliate_name
|
Affiliate Name
|
Int
|
0: No this field.
1: include this field. |
ck_affiliate_manager
|
Affiliate Manager
|
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_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_transaction_id
|
Transaction ID
|
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_language
|
Device Language
|
Int
|
0: No this field.
1: include this field. |
ck_user_agent
|
User Agent
|
Int
|
0: No this field.
1: include this field. |
ck_click_referral
|
Referral URL
|
Int
|
0: No this field.
1: include this field. |
ck_click_ip
|
Click IP
|
Int
|
0: No this field.
1: include this field. |
ck_click_browser
|
Device Browser
|
Int
|
0: No this field.
1: include this field. |
ck_click_time
|
Click Time
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_referral
|
Conversion Referral URL
|
Int
|
0: No this field.
1: include this field. |
ck_payout
|
Payout
|
Int
|
0: No this field.
1: include this field. |
ck_revenue
|
Revenue
|
Int
|
0: No this field.
1: include this field. |
ck_adv_sid
|
Adv SID
|
Int
|
0: No this field.
1: include this field. |
ck_adv_sid2
|
Adv SID 2
|
Int
|
0: No this field.
1: include this field. |
ck_adv_sid3
|
Adv SID 3
|
Int
|
0: No this field.
1: include this field. |
ck_adv_sid4
|
Adv SID 4
|
Int
|
0: No this field.
1: include this field. |
ck_adv_sid5
|
Adv SID 5
|
Int
|
0: No this field.
1: include this field. |
ck_adv_cid
|
Adv CID
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_ip
|
Conversion IP
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_time
|
Conversion Time
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_message
|
Conversion Message
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_note
|
Conversion Note
|
Int
|
0: No this field.
1: include this field. |
ck_conversion_status
|
Conversion Status
|
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 ( Page Size = 100)
|
totalPages
|
Total Pages Count
|
totalItems
|
Total Data Items Count
|
1.1.4 Example
Sample Request URL:
http://{Your_Network_Domain}/api/v1/getConversionReport?key=603E3F0E3266&timezone=8&from=2015/01/01&to=2015/10/31&ck_gross=1&ck_conversion=1&ck_revenue=1&ck_payout=1&page=2
Response sample(page size is 3 in this demo):
http://{Your_Network_Domain}/api/v1/getConversionReport?key=603E3F0E3266&timezone=8&from=2015/01/01&to=2015/10/31&ck_gross=1&ck_conversion=1&ck_revenue=1&ck_payout=1&page=2
Response sample(page size is 3 in this demo):
{
"httpStatus": 200, "data": { "content": [ { "id": "6", "month": "201504", "affiliate_id": "4", "offer_id": "3", "advertiser_id": "2", "ck_offer_id": "3", "currency": "AR$", "from_currency": "AR$", "action": 4, "ck_payout": "1", "ck_revenue": "2" }, { "id": "5", "month": "201504", "affiliate_id": "4", "offer_id": "4", "advertiser_id": "2", "ck_offer_id": "4", "currency": "€ ", "from_currency": "€ ", "action": 4, "ck_payout": "1", "ck_revenue": "2" }, { "id": "8", "month": "201504", "affiliate_id": "4", "offer_id": "4", "advertiser_id": "2", "ck_offer_id": "4", "currency": "B$", "from_currency": "B$", "action": 4, "ck_payout": "1", "ck_revenue": "2" } ], "page": "2", "totalPages": 2, "totalItems": 6 }, "errorCode": 0, "message": "" } |
Close All
API V3
API V2
-
User - Network
-
User - Affiliate
-
Offer
-
Report
-
Dictionary
API V1 (DEPRECATED)