We support you
데이블 뉴스 설치 가이드
일별 광고성과 API
/api/services/:service_name/channels/:channel/stats/ctr/daily
Parameter
| Field | Type | Description |
|---|---|---|
| service_name | String | 필수 서비스명 (ex: dable.io) |
| channel | String | 필수 채널명 (ex: bottom). 전체 채널 데이터를 요청하는 경우 ALL로 지정 |
| access_key | String | 필수 서비스의 비밀키 (ex: Aeh528rGERH53241).대시보드 설정 메뉴 에서 확인 가능 |
| offsetoptional | Number | timezone offset. 한국 시간(KST)의 경우 -540으로 지정 |
| skipoptional | Number | 며칠전 데이터까지 요청할 것인가 지정. 0: 어제, 1: 그제, 2: 3일전, … |
| agooptional | Number | 며칠 치 데이터까지 요청할 것인가 지정. 최대 62일까지 지정 가능. |
Success 200
| Field | Type | Description |
|---|---|---|
| result | Object | 응답 결과 |
| data | Object | 일별 광고성과 데이터 |
| data[date] | Object | 매출 발생 날짜 |
| sum | Object | 광고성과 합계 데이터 |
| ctr | Object | 클릭률 |
| impressions | Object | 노출수 |
| exposes | Object | 유효노출수 |
| clicks | Object | 클릭수 |
| cost_spent | Object | 총 광고매출 |
| sharing_cost | Object | 정산매출 |
| void_cost_spent | Object | 무효매출 |
| last_updated | String | 최종 업데이트 일시(ISO 8601 포맷) |
| channels | String | 전체 채널 목록 |
Success-Response
HTTP/1.1 200 OK
{
"result": {
"data": {
"20161108": {
"ctr": 1.274,
"impressions": 293432,
"exposes": 28441,
"clicks": 360,
"cost_spent": 54743,
"sharing_cost": 25293,
"void_cost_spent": 957
},
"20161109": {
"ctr": 1.233,
"impressions": 335380,
"exposes": 30320,
"clicks": 341,
"cost_spent": 37318,
"sharing_cost": 25100,
"void_cost_spent": 120
}
},
"sum": {
"ctr": 1.253,
"impressions": 328812,
"exposes": 58961,
"clicks": 731,
"cost_spent": 102061,
"sharing_cost": 51773,
"void_cost_spent": 1677
},
"last_updated": "2016-11-09T16:13:51.000Z",
"channels": [
"bottom",
"middle"
]
}
}
400
| Field | Description |
|---|---|
| badRequest | service_name(서비스명), access_key(비밀키)가 잘못된 경우, ago가 62를 초과하는 경우 |
500
| Field | Description |
|---|---|
| serverError | DB 접속 실패 등 서버 오류 |
Error-Response on 400:
HTTP/1.1 400 Bad Request
{
"errors": [
{
"message": "invalid service or public key"
}
]
일별 광고성과 (매체사 관리자 단위)
/api/service_admins/:login_id/stats/ctr/daily
Parameter
| Field | Type | Description |
|---|---|---|
| login_id | String | 필수 관리자ID (ex: dable) |
| access_key | String | 필수 관리자의 비밀키 (ex: Aeh528rGERH53241). 대시보드의 개인정보 확인/수정 메뉴에서 확인 가능 |
| offsetoptional | Number | timezone offset. 한국 시간(KST)의 경우 -540으로 지정 |
| from_dateoptional | String | 데이터를 요청할 시작날짜 (예: 2016-01-01) |
| to_dateoptional | String | 데이터를 요청할 끝날짜 (예: 2016-02-01) |
| by_channeloptional | Number | 1로 지정 시 채널별 데이터 요청 |
Success 200
| Field | Type | Description |
|---|---|---|
| result | Object | 응답 결과 |
| service_id | Number | 서비스ID(ex: 1) |
| service_name | String | 서비스명(ex: dable.io) |
| data | Object | 일별 광고성과 데이터 |
| data[date] | Number | 매출 발생 날짜 |
| sum | Object | 광고성과 합계 데이터 |
| ctr | Number | 클릭률 |
| impressions | Number | 노출수 |
| exposes | Number | 유효노출수 |
| clicks | Number | 클릭수 |
| cost_spent | Number | 총 광고매출 |
| sharing_cost | Number | 정산매출 |
| void_cost_spent | Number | 무효매출 |
| last_updated | String | 최종 업데이트 일시(ISO 8601 포맷) |
| channels | String[] | 전체 채널 목록 |
| channel_widget_map | Object | 채널명 – 위젯ID map |
| channel_widget_map[channel] | String | channel에 해당하는 위젯ID. 해당하는 위젯ID가 없을 경우 ‘UNKNOWN’으로 노출 |
Success-Response
HTTP/1.1 200 OK
{
"result": [{
"service_id": 1,
"service_name": "dable.io",
"data": {
"20161108": {
"ctr": 1.274,
"impressions": 293432,
"exposes": 28441,
"clicks": 360,
"cost_spent": 54743,
"sharing_cost": 25293,
"void_cost_spent": 957
},
"20161109": {
"ctr": 1.233,
"impressions": 335380,
"exposes": 30320,
"clicks": 341,
"cost_spent": 37318,
"sharing_cost": 25100,
"void_cost_spent": 120
}
},
"sum": {
"ctr": 1.253,
"impressions": 328812,
"exposes": 58961,
"clicks": 731,
"cost_spent": 102061,
"sharing_cost": 51773,
"void_cost_spent": 1677
},
"last_updated": "2016-11-09T16:13:51.000Z",
"channels": [
"bottom",
"middle"
],
"channel_widget_map": {
"bottom": "je7EFa94",
"middle": "k29Iq4v7"
}
}, {
"data": {
// (중략)
},
}]
}
400
| Field | Description |
|---|---|
| badRequest | login_id(관리자ID), access_key(비밀키)가 잘못된 경우, from_date와 to_date가 62일을 초과하는 경우 |
500
| Field | Description |
|---|---|
| serverError | EDB 접속 실패 등 서버 오류 |
Error-Response on 400:
HTTP/1.1 400 Bad Request
{
"errors": [
{
"message": "invalid service admin or access key"
}
]
}