API Get conversions by publisher
1. Get conversions
Base URL (develop enviroment) :
ENDPOINT: /publisher/conversion
METHOD: GET
HEADER:
{
X-Port-Type:PUB,
Authorization: Bear {access_token}
}PARAMETERS:
page: 1
page_size: 20
order_id:
campaign_id:
click_id:
status:
from_time: 2020-10-26 17:43:55
to_time: 2020-11-02 17:43:55BODY: NONE
RESPONSE:
1.Status: Error
{
"status": "fail",
"message": "some thing went wrong!"
}1.Status: Success
{
"status": "success",
"data": {
"conversions": [
{
"conversion_id": "5f9b9efa6c906f0c5519d820",
"invoice_id": null,
"click_id": "808f0580affb4e14ad59cfe44b1b75f0",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"order_id": "d0341a71efb24bee83957d36bc4df83b",
"action": "sale",
"action_time": 1604034297962,
"action_date_time": "2020-10-30T12:04:57+0700",
"total_discount": {
"amount": 0,
"currency": "VND"
},
"total_sale_amount": {
"amount": 3000.756,
"currency": "VND"
},
"total_commission": {
"amount": 1050.2646,
"currency": "VND"
},
"client_ip": "222.252.31.45",
"user_agent": "PostmanRuntime\/7.26.8",
"conversion_parts": [
{
"sku": "001",
"name": "product_01",
"url": null,
"quantity": 3,
"currency": "VND",
"commission": {
"amount": 1050.2646,
"currency": "VND"
},
"status": "pending",
"reason": null,
"id": "3",
"price": 1000.252,
"discount": 0,
"sale_amount": 3000.756,
"calculate_by": "FIXED",
"calculate_by_id": null,
"category_name": "cate_001",
"category_id": null
}
],
"status": "pending",
"reason": null,
"created_time": "2020-10-30T12:04:58+0700",
"updated_time": "2020-10-30T12:06:40+0700",
"advertiser": null,
"publisher": "aryastark",
"click_detail": {
"click_id": "808f0580affb4e14ad59cfe44b1b75f0",
"publisher_id": "17075",
"publisher_name": "aryastark",
"ad_space_code": "ADS000000611",
"contract_no": null,
"advertiser_name": null,
"campaign_name": "Summer Bakery",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"campaign_domain": "summer.vn",
"client": {
"clientId": "bcb5247a6f4b467f808c55205f8b9503",
"clientIp": "222.252.31.45",
"clientTimeZone": "GMT+07:00",
"clientLang": "vi",
"userAgent": "PostmanRuntime\/7.26.8",
"deviceModel": "Other",
"deviceFamily": "Unknown",
"deviceBrand": "unknown",
"deviceType": "Desktop",
"deviceName": "Unknown",
"deviceOs": "Unknown",
"deviceBrowserId": "16843022",
"deviceBrowserName": "Unknown",
"deviceBrowserVersion": null,
"location": "VN",
"mobileDevice": false,
"desktopDevice": true,
"tabletDevice": false
},
"click_uri": "Local API",
"referer_uri": "#",
"origin_uri": null,
"target_uri": "#",
"status": null,
"version": "v1",
"click_time": "2020-10-30T12:04:56+0700"
},
"cal_commission": {
"total_cal_commission": {
"amount": 1050.2646,
"currency": "VND"
},
"total_cal_commission_pub": {
"amount": 750.189,
"currency": "VND"
},
"total_cal_commission_at": {
"amount": 300.07559999999995,
"currency": "VND"
},
"total_cal_commission_agent": {
"amount": 0,
"currency": "VND"
},
"cal_commission_parts": null
},
"adv_utm_param": {
"utm_source": "accessTrade",
"utm_medium": "CPO",
"utm_campaign": "CAM000000411",
"utm_term": "",
"utm_content": ""
},
"pub_utm_param": {
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": null,
"utm_content": "",
"sub": "",
"sub1": "",
"sub2": "",
"sub3": "",
"sub4": ""
}
},
{
"conversion_id": "5f9b8e1c6c906f0c5519d807",
"invoice_id": null,
"click_id": "5fe37da6ef2142fc823498b48cf5322f",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"order_id": "99f4a4c1fd354760a2c78e402828d357",
"action": "sale",
"action_time": 1604029980568,
"action_date_time": "2020-10-30T10:53:00+0700",
"total_discount": {
"amount": 0,
"currency": "VND"
},
"total_sale_amount": {
"amount": 76,
"currency": "VND"
},
"total_commission": {
"amount": 26.59965,
"currency": "VND"
},
"client_ip": "222.252.31.232",
"user_agent": "PostmanRuntime\/7.26.8",
"conversion_parts": [
{
"sku": "NGHI",
"name": "product_01",
"url": null,
"quantity": 3,
"currency": "VND",
"commission": {
"amount": 26.59965,
"currency": "VND"
},
"status": "pre_approved",
"reason": "System update status conversion",
"id": "3",
"price": 25.333,
"discount": 0,
"sale_amount": 76,
"calculate_by": "FIXED",
"calculate_by_id": null,
"category_name": "cate_001",
"category_id": null
}
],
"status": "pre_approved",
"reason": [
{
"log_time": "2020-10-30T12:01:34+0700",
"log_action": "edit[Conversion_Info by mp_core_recheck]",
"log_message": "H\u1ec7 th\u1ed1ng c\u1eadp nh\u1eadt"
},
{
"log_time": "2020-10-30T12:01:34+0700",
"log_action": "update[ConversionStatus=pre_approved by mp_core_recheck]",
"log_message": "System update status conversion"
},
{
"log_time": "2020-11-02T09:36:19+0700",
"log_action": "edit[Conversion_Info by mp_core_recheck]",
"log_message": "H\u1ec7 th\u1ed1ng c\u1eadp nh\u1eadt"
}
],
"created_time": "2020-10-30T10:53:00+0700",
"updated_time": "2020-11-02T09:36:40+0700",
"advertiser": null,
"publisher": "aryastark",
"click_detail": {
"click_id": "5fe37da6ef2142fc823498b48cf5322f",
"publisher_id": "17075",
"publisher_name": "aryastark",
"ad_space_code": "ADS000000611",
"contract_no": null,
"advertiser_name": null,
"campaign_name": "Summer Bakery",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"campaign_domain": "summer.vn",
"client": {
"clientId": "184970474f73a66775660c535513807c",
"clientIp": "222.252.31.232",
"clientTimeZone": "GMT+07:00",
"clientLang": "vi",
"userAgent": "PostmanRuntime\/7.26.8",
"deviceModel": "Other",
"deviceFamily": "Unknown",
"deviceBrand": "unknown",
"deviceType": "Desktop",
"deviceName": "Unknown",
"deviceOs": "Unknown",
"deviceBrowserId": "16843022",
"deviceBrowserName": "Unknown",
"deviceBrowserVersion": null,
"location": "VN",
"mobileDevice": false,
"desktopDevice": true,
"tabletDevice": false
},
"click_uri": "Local API",
"referer_uri": "#",
"origin_uri": null,
"target_uri": "#",
"status": null,
"version": "v1",
"click_time": "2020-10-30T10:53:00+0700"
},
"cal_commission": {
"total_cal_commission": {
"amount": 26.59965,
"currency": "VND"
},
"total_cal_commission_pub": {
"amount": 18.99975,
"currency": "VND"
},
"total_cal_commission_at": {
"amount": 7.599900000000002,
"currency": "VND"
},
"total_cal_commission_agent": {
"amount": 0,
"currency": "VND"
},
"cal_commission_parts": null
},
"adv_utm_param": {
"utm_source": "accessTrade",
"utm_medium": "CPO",
"utm_campaign": "CAM000000411",
"utm_term": "",
"utm_content": ""
},
"pub_utm_param": {
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": null,
"utm_content": "",
"sub": "",
"sub1": "",
"sub2": "",
"sub3": "",
"sub4": ""
}
}
],
"meta": {
"page": 1,
"page_size": 20,
"total": 2,
"total_sale_amount": 3076.756,
"total_pub_commission": 769.189,
"total_agent_commission": 0,
"total_at_commission": 307.675,
"total_commission": 1076.864,
"total_conversion_part_quantity": 6,
"summary": {
"conversion": null,
"sale_amount": {
"total": 3076.756,
"approved": 0,
"pre_approved": 76,
"rejected": 0,
"hold": 0,
"pending": 3000.756
},
"platform_fee": {
"total": 0,
"approved": 0,
"pre_approved": 0,
"rejected": 0,
"hold": 0,
"pending": 0
},
"pub_com": {
"total": 769.189,
"approved": 0,
"pre_approved": 19,
"rejected": 0,
"hold": 0,
"pending": 750.189
},
"at_com": {
"total": 307.675,
"approved": 0,
"pre_approved": 7.6,
"rejected": 0,
"hold": 0,
"pending": 300.076
}
}
}
}
}2. Get conversion detail
Base URL (develop enviroment) :
ENDPOINT: /conversion/{conversion_id}
METHOD: GET
HEADER:
{ X-Port-Type:PUB, Authorization: Bear {access_token} }
PARAMETERS: NONE
BODY: NONE
RESPONSE:
1.Status: Error
{
"status": "fail",
"message": "some thing went wrong!"
}1.Status: Success
{
"status": "success",
"data": {
"conversion": {
"conversion_id": "5f9b8e1c6c906f0c5519d807",
"invoice_id": null,
"click_id": "5fe37da6ef2142fc823498b48cf5322f",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"order_id": "99f4a4c1fd354760a2c78e402828d357",
"action": "sale",
"action_time": 1604029980568,
"action_date_time": "2020-10-30T10:53:00+0700",
"total_discount": {
"amount": 0,
"currency": "VND"
},
"total_sale_amount": {
"amount": 76,
"currency": "VND"
},
"total_commission": {
"amount": 26.59965,
"currency": "VND"
},
"client_ip": "222.252.31.232",
"user_agent": "PostmanRuntime\/7.26.8",
"conversion_parts": [
{
"sku": "NGHI",
"name": "product_01",
"url": null,
"quantity": 3,
"currency": "VND",
"commission": {
"amount": 26.59965,
"currency": "VND"
},
"status": "pre_approved",
"reason": "System update status conversion",
"id": "3",
"price": 25.333,
"discount": 0,
"sale_amount": 76,
"calculate_by": "FIXED",
"calculate_by_id": null,
"category_name": "cate_001",
"category_id": null
}
],
"status": "pre_approved",
"reason": [
{
"log_time": "2020-10-30T12:01:34+0700",
"log_action": "edit[Conversion_Info by mp_core_recheck]",
"log_message": "H\u1ec7 th\u1ed1ng c\u1eadp nh\u1eadt"
},
{
"log_time": "2020-10-30T12:01:34+0700",
"log_action": "update[ConversionStatus=pre_approved by mp_core_recheck]",
"log_message": "System update status conversion"
},
{
"log_time": "2020-11-02T09:36:19+0700",
"log_action": "edit[Conversion_Info by mp_core_recheck]",
"log_message": "H\u1ec7 th\u1ed1ng c\u1eadp nh\u1eadt"
}
],
"created_time": "2020-10-30T10:53:00+0700",
"updated_time": "2020-11-02T09:36:40+0700",
"advertiser": null,
"publisher": "aryastark",
"click_detail": {
"click_id": "5fe37da6ef2142fc823498b48cf5322f",
"publisher_id": "17075",
"publisher_name": "aryastark",
"ad_space_code": "ADS000000611",
"contract_no": null,
"advertiser_name": null,
"campaign_name": "Summer Bakery",
"campaign_id": "411",
"campaign_code": "CAM000000411",
"campaign_domain": "summer.vn",
"client": {
"clientId": "184970474f73a66775660c535513807c",
"clientIp": "222.252.31.232",
"clientTimeZone": "GMT+07:00",
"clientLang": "vi",
"userAgent": "PostmanRuntime\/7.26.8",
"deviceModel": "Other",
"deviceFamily": "Unknown",
"deviceBrand": "unknown",
"deviceType": "Desktop",
"deviceName": "Unknown",
"deviceOs": "Unknown",
"deviceBrowserId": "16843022",
"deviceBrowserName": "Unknown",
"deviceBrowserVersion": null,
"location": "VN",
"mobileDevice": false,
"desktopDevice": true,
"tabletDevice": false
},
"click_uri": "Local API",
"referer_uri": "#",
"origin_uri": null,
"target_uri": "#",
"status": null,
"version": "v1",
"click_time": "2020-10-30T10:53:00+0700"
},
"cal_commission": {
"total_cal_commission": {
"amount": 26.59965,
"currency": "VND"
},
"total_cal_commission_pub": {
"amount": 18.99975,
"currency": "VND"
},
"total_cal_commission_at": {
"amount": 7.599900000000002,
"currency": "VND"
},
"total_cal_commission_agent": {
"amount": 0,
"currency": "VND"
},
"cal_commission_parts": [
{
"conversion_id": "5f9b8e1c6c906f0c5519d807",
"conversion_part_id": "3",
"cal_commission": {
"total_cal_commission": {
"amount": 26.59965,
"currency": "VND"
},
"total_cal_commission_pub": {
"amount": 18.99975,
"currency": "VND"
},
"total_cal_commission_at": {
"amount": 7.599900000000002,
"currency": "VND"
},
"total_cal_commission_agent": {
"amount": 0,
"currency": "VND"
},
"cal_commission_parts": null
}
}
]
},
"adv_utm_param": {
"utm_source": "accessTrade",
"utm_medium": "CPO",
"utm_campaign": "CAM000000411",
"utm_term": "",
"utm_content": ""
},
"pub_utm_param": {
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": null,
"utm_content": "",
"sub": "",
"sub1": "",
"sub2": "",
"sub3": "",
"sub4": ""
}
}
}
}Last updated
Was this helpful?