도메인 |
---|
https://api-alimtalk.cloud.toast.com |
[URL]
Http method | URI |
---|---|
GET | /common/v2.2/appkeys/{appKey}/stats |
[Path parameter]
이름 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 앱키 |
[Query parameter]
이름 | 타입 | 최대 길이 | 필수 | 설명 |
---|---|---|---|---|
statsType | String | - | 필수 | 통계 구분 NORMAL:기본, MINUTELY:분별, HOURLY:시간별, DAILY:일별, BY_DAY:요일별 |
from | String | - | 필수 | 통계 검색 시작 날짜 yyyy-MM-dd HH:mm:ss |
to | String | - | 필수 | 통계 검색 종료 날짜 yyyy-MM-dd HH:mm:ss |
join | Boolean | - | 옵션 | 통계 데이터 조회 시, 트리 형태로 제공할 지 설정 |
extra1s | List |
- | 옵션 | 하위 상품 구분 ALIMTALK, ALIMTALK_AUTH, FRIENDTALK |
extra2s | List |
- | 옵션 | senderKey |
eventTypes | List |
- | 옵션 | 이벤트 종류 REQUESTED, SENT, RECEIVED, SENT_FAILED, RESENT, RESENT_FAILED |
eventCategory | String | - | 옵션 | 이벤트 목록(현재 MESSAGE 만 지원)MESSAGE |
templateCodes | List |
- | 옵션 | 템플릿 코드 목록(친구톡 미지원) |
requestIds | List |
5 | 옵션 | 요청 ID 목록 |
statsIds | List |
- | 옵션 | 통계 ID 목록 |
statsCriteria | List |
- | 옵션 | 통계 기준 - EVENT: 이벤트(기본 값) - EXTRA_1,EVENT: 하위 상품 구분, 이벤트 - EXTRA_2,EVENT: senderKey, 이벤트 |
[Response body]
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"stats": [
{
"eventDateTime": "2021-10-13T00:00:00.000Z",
"events": {
"RECEIVED": 5,
"RESENT_FAILED": 0,
"SENT_FAILED": 0,
"REQUESTED": 1,
"RESENT": 0,
"SENT": 5
}
},
{
"eventDateTime": "2021-10-14T00:00:00.000Z",
"events": {
"RECEIVED": 25,
"RESENT_FAILED": 1,
"SENT_FAILED": 19,
"REQUESTED": 55,
"RESENT": 0,
"SENT": 27
}
}
]
}
[URL]
Http method | URI |
---|---|
GET | /common/v2.2/appkeys/{appKey}/stats/total |
[Path parameter]
이름 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 앱키 |
[Query parameter]
이름 | 타입 | 최대 길이 | 필수 | 설명 |
---|---|---|---|---|
statsType | String | - | 필수 | 통계 구분 NORMAL:기본, MINUTELY:분별, HOURLY:시간별, DAILY:일별, BY_DAY:요일별 |
from | String | - | 필수 | 통계 검색 시작 날짜 yyyy-MM-dd HH:mm:ss |
to | String | - | 필수 | 통계 검색 종료 날짜 yyyy-MM-dd HH:mm:ss |
join | Boolean | - | 옵션 | 통계 데이터 조회 시, 트리 형태로 제공할 지 설정 |
extra1s | List |
- | 옵션 | 하위 상품 구분 ALIMTALK, ALIMTALK_AUTH, FRIENDTALK |
extra2s | List |
- | 옵션 | senderKey |
eventTypes | List |
- | 옵션 | 이벤트 종류 REQUESTED, SENT, RECEIVED, SENT_FAILED, RESENT, RESENT_FAILED |
eventCategory | String | - | 옵션 | 이벤트 목록(현재 MESSAGE 만 지원)MESSAGE |
templateCodes | List |
- | 옵션 | 템플릿 코드 목록(친구톡 미지원) |
requestIds | List |
5 | 옵션 | 요청 ID 목록 |
statsIds | List |
- | 옵션 | 통계 ID 목록 |
statsCriteria | List |
- | 옵션 | 통계 기준 - EVENT: 이벤트(기본 값) - EXTRA_1,EVENT: 하위 상품 구분, 이벤트 - EXTRA_2,EVENT: senderKey, 이벤트 |
[Response body]
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"total": {
"RECEIVED": 45,
"REQUESTED": 56,
"RESENT": 0,
"RESENT_FAILED": 1,
"SENT": 47,
"SENT_FAILED": 19
}
}