통계

Notification > Notification Hub > API v1.0 사용 가이드 > 통계

통계 조회

통계 이벤트를 이벤트가 발생한 시간 기준으로 조회합니다.

요청

GET /stats/v1.0/stats
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

• 메시지 채널에 따라 설정할 수 있는 이벤트 카테고리가 달라집니다.

  메시지 채널	이벤트 카테고리
  SMS	MESSAGE_SEND, INTERNATIONAL_MESSAGE_SEND
  ALIMTALK, FRIENDTALK, RCS, EMAIL, PUSH	MESSAGE_SEND
  * 조회 시작 일시는 조회 기간에 포함이 되며, 조회 종료 일시는 조회 기간에 포함되지 않습니다.
  * 예: 2025년 1월 1일 하루 데이터를 조회하기 위해서는 eventDateTimeFrom을 2025-01-01T00:00:00.000+09:00로 설정하고 eventDateTimeTo를 2025-01-02T00:00:00.000+09:00로 설정해야 합니다.
  * 이벤트 외 추가로 데이터를 수집해 총 3개(extra1, extra2, extra3)의 추가 필드를 제공합니다.
  설정된 이벤트 카테고리에 따라 추가 수집되는 데이터의 종류가 다릅니다.

  이벤트 카테고리	추가 데이터 1	추가 데이터 2	추가 데이터 3
  MESSAGE_SEND	발송 유형(SMS, LMS, MMS 등)	발송 목적(NORMAL, AUTH, AD)	발신 정보(발신 번호, 발신 도메인 등)
  INTERNATIONAL_MESSAGE_SEND	발송 유형(SMS, LMS, MMS 등)	발송 목적(NORMAL, AUTH, AD)	발신 정보(발신 번호, 발신 도메인 등)

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "stats" : {
    "columns" : [ {
      "name" : "EVENT_DATE_TIME"
    }, {
      "name" : "REQUESTED"
    }, {
      "name" : "SENT"
    }, {
      "name" : "SEND_FAILED"
    }, {
      "name" : "DELIVERED"
    }, {
      "name" : "DELIVERY_FAILED"
    }, {
      "name" : "OPENED"
    } ],
    "rows" : [ {
      "EVENT_DATE_TIME" : "2023-12-31T00:00:00.000+09:00",
      "REQUESTED" : 10,
      "SENT" : 10,
      "SEND_FAILED" : 1,
      "DELIVERED" : 7,
      "DELIVERY_FAILED" : 1,
      "OPENED" : 1
    } ]
  }
}

요청 예시

### 통계 조회

GET {{endpoint}}/stats/v1.0/stats?eventCategory={{eventCategory}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

curl -X GET "${endpoint}/stats/v1.0/stats?eventCategory=${eventCategory}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"