Report API for MAT
5 minute read
Chansup Yang
Basic info
Domain and API keys are provided separately.
Code definition
Division |
Code |
Description |
ERROR_CODE |
0 |
success |
|
1 |
system error |
|
2 |
unknown error |
|
3 |
no permissions |
|
4 |
non-exist API |
|
5 |
incorrect Parameter |
|
6 |
Date must be entered and cannot exceed 3 months |
OS_CODE |
2 |
iOS |
|
3 |
Android |
|
-1 |
unknown |
Adver report
Request URL
URL |
Method |
/S-Plus_api/MAT/getAdverList.xml |
Get |
/S-Plus_api/MAT/getAdverList.json |
Get |
Request Parameters
Field |
Type |
Required |
Example |
Description |
sDate |
String |
Y |
20160101 |
report query start date |
eDate |
String |
Y |
20160131 |
report query end date |
USER |
String |
Y |
|
API key |
Auth_Type |
String |
Y |
mat |
authority |
Respose Fields
Field |
Type |
Example |
Description |
Adver_List_Count |
Integer |
1 |
returned row count |
AdverList.Adver_List |
Array |
|
|
adver_no |
Integer |
1645 |
adver ID |
adver_name |
String |
AAA |
adver name |
brand_no |
Integer |
2944 |
brand ID |
brand_name |
String |
BBB |
brand name |
imps |
Integer |
145 |
impression count |
click |
Integer |
561 |
click count |
Respose Sample
{
"error_code": "000",
"Adver_List_Count": 1,
"Adver_List": [
{
"adver_no": 1645,
"adver_name": "펀플웍스",
"brand_no": 2912,
"brand_name": "완소여단",
"imps": 51,
"click": 0
}
]
}
Campaign Report
Request URL
URL |
Method |
/S-Plus_api/MAT/getCampaignList.xml |
Get |
/S-Plus_api/MAT/getCampaignList.json |
Get |
Request Parameters
Field |
Type |
Required |
Example |
Description |
sDate |
String |
Y |
20160101 |
report query start date |
eDate |
String |
Y |
20160131 |
report query end date |
USER |
String |
Y |
|
API key |
Auth_Type |
String |
Y |
mat |
authority |
Adver_No |
Integer |
Y |
1645 |
adver ID |
Brand_No |
Integer |
N |
2944 |
brand ID |
Group_Day |
Integer |
N |
1 |
0 : Grouping by date - No |
|
|
|
|
1 : Grouping by dtae - Yes |
Group_OS |
Integer |
N |
1 |
0 : Grouping by OS - No |
|
|
|
|
1 : Grouping by OS - Yes |
Respose Fields
Field |
Type |
Example |
Description |
Campaign_List_Count |
Integer |
1 |
returned row count |
Campaign_List.Campaign_List |
Array |
|
|
cmp_no |
Integer |
306 |
campaign no |
cmp_id |
String |
campaign_test |
campaign name |
app_id_android |
String |
test.android |
app ID ( android ) |
app_id_ios |
String |
test.ios |
app ID ( iOS ) |
cmp_start_date |
String |
2018-10-01 |
campaign start date |
cmp_end_date |
String |
2018-10-15 |
campaign end date |
cmp_budget_total |
Integer |
515110 |
campaign total budget |
currency |
String |
KRW |
currency |
imps |
Integer |
145 |
impression count |
click |
Integer |
561 |
click count |
cost |
Integer |
1742 |
amount spent |
day |
String |
2018-10-01 |
report date ( return only if Group_Day is 1 ) |
os_code |
String |
1 |
OS code ( return only if Group_OS is 1 ) |
Respose Sample
{
"error_code": "000",
"Campaign_List_Count": 1,
"Campaign_List": [
{
"cmp_no": 306,
"cmp_id": "20170421_ENP Games_반지_NCPI",
"app_id_android": "aaa",
"app_id_ios": "bbb",
"cmp_start_date": "2017-04-20",
"cmp_end_date": "2017-08-31",
"cmp_budget_total": 200000000,
"currency": "KRW",
"imps": 0,
"click": 39580372,
"cost": 0
}
]
}
Ad report
Request URL
URL |
Method |
/S-Plus_api/MAT/getADList.xml |
Get |
/S-Plus_api/MAT/getADList.json |
Get |
Request Parameters
Field |
Type |
Required |
Example |
Description |
sDate |
String |
Y |
20160101 |
report query start date |
eDate |
String |
Y |
20160131 |
report query end date |
USER |
String |
Y |
|
API key |
Auth_Type |
String |
Y |
mat |
authority |
Adver_No |
Integer |
Y |
1645 |
adver ID |
Cmp_No |
Integer |
Y |
306 |
campaign no |
Group_Day |
Integer |
N |
1 |
report date ( return only if Group_Day is 1 ) |
Group_OS |
Integer |
N |
1 |
OS code ( return only if Group_OS is 1 ) |
Group_Pub |
Integer |
N |
1 |
publisher code ( return only if Group_Pub is 1 ) |
Respose Fields
Field |
Type |
Example |
Description |
AD_Count |
Integer |
1 |
returned row count |
AD_List.AD_List |
Array |
|
|
ads_no |
Integer |
9502 |
ad no |
ads_id |
String |
ad11 |
ad name |
img_path |
String |
|
creative path |
landing_url |
String |
http://www.mezzomedia.co.kr |
destination url |
currency |
String |
KRW |
currency |
imps |
Integer |
5151 |
impression count |
click |
Integer |
144 |
click count |
cost |
Integer |
3050 |
amount spent |
day |
String |
2018-10-01 |
report date ( return only if Group_Day is 1 ) |
os_code |
Integer |
3 |
OS code ( return only if Group_OS is 1 ) |
section_no |
Integer |
5 |
publishe code ( return only if Group_Pub is 1 ) |
Respose Sample
{
"error_code": "000",
"AD_List_Count": 2,
"AD_List": [
{
"ads_no": 9502,
"ads_id": "20170421_ENP Games_반지_NCPI_AOS",
"img_path": "",
"landing_url": "",
"currency": "KRW",
"imps": 0,
"click": 38725073,
"cost": 0
},
{
"ads_no": 9503,
"ads_id": "20170421_ENP Games_반지_NCPI_iOS",
"img_path": "",
"landing_url": "",
"currency": "KRW",
"imps": 0,
"click": 855299,
"cost": 0
}
]
}