API v2.2 ガイド - NHN Cloud 使用ガイド

Notification > KakaoTalk Bizmessage > Common > API v2.2 Guide

統計

[APIドメイン]

ドメイン
https://kakaotalk-bizmessage.api.nhncloudservice.com

統計検索 - イベントベース

イベント発生時間基準で収集された統計です。
次の時間を基準に統計が収集されます。
- リクエスト数(REQUESTED)：予約送信登録時間
- 送信数(SENT)：ベンダーに送信時点(予約送信時間)
- 成功数(RECEIVED)：送信結果成功(受信時間)
- 失敗数(SENT_FAILED)：送信リクエスト失敗or送信結果失敗時点
- 代替送信リクエスト数(RESENT)：代替送信リクエスト時点
- 代替送信失敗数(RESENT_FAILED)：代替送信リクエスト失敗時点

統計情報照会

[URL]

Http method	URI
GET	/common/v2.2/appkeys/{appKey}/stats

[Path parameter]

値	タイプ	説明
appKey	String	固有のアプリケーションキー

[Header]

{
  "X-Secret-Key": String
}

値	タイプ	必須	説明
X-Secret-Key	String	O	コンソールで作成できます。

[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, BRAND_MESSAGE
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, BRAND_MESSAGE
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
    }
}

Kakao統計

Kakao Biz Centerで提供する統計データを照会します。
統計データは送信元キーを基準として日別(DAILY)または月別(MONTHLY)で照会できます。
DAILY：直近90日以内のデータのみ照会可能であり、照会範囲は最大90日です。
MONTHLY：直近3か月以内のデータのみ照会可能であり、照会範囲は最大3か月です。

送信元プロフィール管理でKakao統計へ移動をクリックすると、新しいウィンドウでKakao統計を照会できます。統計基準には送信統計とテンプレート統計があり、メッセージチャンネルによって照会条件が異なります。照会結果をチャートと表で確認できます。

リアルタイムの統計は提供しておらず、前日に収集したデータを毎日午前7時頃に提供します。
お知らせトークの統計はD+1に初回提供し、D+2に確定します。
有効既読数は同じメッセージに対して重複集計しません。
クリック数は同じメッセージに対して重複集計します。
送信成功件数が10件以下の場合は、有効既読数とクリック数を提供しません。

送信統計

送信元プロフィールを基準として、日別の送信数、有効既読数、クリック数を照会します。期間、送信識別子、メッセージタイプなどを設定して照会できます。

テンプレート統計

テンプレート及びグループタグを基準として、日別の送信数、有効既読数、クリック数を照会します。期間、メッセージタイプなどを設定して照会できます。

ブランドメッセージ(自由型)はグループタグを使用した場合にのみ提供します。

お知らせトーク送信統計の照会

リクエスト

[URL]

Http method	URI
GET	/common/v2.2/appkeys/{appKey}/kakao-statistics/delivery-statistics/ALIMTALK

[Path parameter]

名前	タイプ	説明
appKey	String	固有のアプリキー

[Header]

{
  "X-Secret-Key": String
}

名前	タイプ	必須	説明
X-Secret-Key	String	O	コンソールで作成できます。

[Query parameter]

名前	タイプ	必須	説明
senderKey	String	O	送信元キー
periodType	String	O	統計区分(DAILY：日別、MONTHLY：月別)
startDate	String	O	照会開始日 DAILY：yyyy-MM-dd(直近90日以内)、MONTHLY：yyyy-MM(直近3か月以内)
endDate	String	O	照会終了日 DAILY：yyyy-MM-dd(最大範囲90日)、MONTHLY：yyyy-MM(最大範囲3か月)
messageType	String	X	メッセージのタイプ(AT：一般お知らせトーク、AI：画像お知らせトーク)
receiveUserType	String	X	受信者のタイプ(PhoneNumber：電話番号、None：受信者の識別子なし)
limit	Integer	X	照会件数(Default：500、Max：1000)
offset	Integer	X	開始位置(Default：0)

レスポンス

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "totalCount": 1,
    "alimtalkDeliveryStatistics": [
        {
            "date": "2026-04-01",
            "messageType": "NORMAL",
            "receiveUserType": "ALL",
            "totalSendRequestCount": 100,
            "validSendRequestCount": 95,
            "validReadCount": 80
        }
    ]
}

名前	タイプ	Not Null	説明
header	Object	O	ヘッダ領域
- resultCode	Integer	O	結果コード
- resultMessage	String	O	結果メッセージ
- isSuccessful	Boolean	O	成否
totalCount	Integer	O	総数
alimtalkDeliveryStatistics	List	O	お知らせトーク送信統計リスト
- date	String	O	日付
- messageType	String	O	メッセージのタイプ(AT：一般お知らせトーク、AI：画像お知らせトーク)
- receiveUserType	String	O	受信者のタイプ(PhoneNumber：電話番号、None：受信者の識別子なし)
- totalSendRequestCount	Integer	O	総送信リクエスト数
- validSendRequestCount	Integer	O	有効送信リクエスト数
- validReadCount	Integer	O	有効既読数

お知らせトークテンプレート統計の照会

リクエスト

[URL]

Http method	URI
GET	/common/v2.2/appkeys/{appKey}/kakao-statistics/template-statistics/ALIMTALK

[Path parameter]

名前	タイプ	説明
appKey	String	固有のアプリキー

[Header]

{
  "X-Secret-Key": String
}

名前	タイプ	必須	説明
X-Secret-Key	String	O	コンソールで作成できます。

[Query parameter]

名前	タイプ	必須	説明
senderKey	String	O	送信元キー
periodType	String	O	統計区分(DAILY：日別、MONTHLY：月別)
startDate	String	O	照会開始日 DAILY：yyyy-MM-dd(直近90日以内)、MONTHLY：yyyy-MM(直近3か月以内)
endDate	String	O	照会終了日 DAILY：yyyy-MM-dd(最大範囲90日)、MONTHLY：yyyy-MM(最大範囲3か月)
kakaoTemplateCode	String	X	Kakaoのテンプレートコード
messageType	String	X	メッセージのタイプ(AT：一般お知らせトーク、AI：画像お知らせトーク)
limit	Integer	X	照会件数(Default：500、Max：1000)
offset	Integer	X	開始位置(Default：0)

レスポンス

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "totalCount": 1,
    "alimtalkTemplateStatistics": [
        {
            "date": "2026-04-01",
            "messageType": "NORMAL",
            "templateCode": "template01",
            "totalSendSuccessCount": 90,
            "validReadCount": 75,
            "totalClickCount": 30
        }
    ]
}

名前	タイプ	Not Null	説明
header	Object	O	ヘッダ領域
- resultCode	Integer	O	結果コード
- resultMessage	String	O	結果メッセージ
- isSuccessful	Boolean	O	成否
totalCount	Integer	O	総数
alimtalkTemplateStatistics	List	O	お知らせトークテンプレート統計リスト
- date	String	O	日付
- messageType	String	O	メッセージのタイプ(AT：一般お知らせトーク、AI：画像お知らせトーク)
- templateCode	String	O	テンプレートコード
- totalSendSuccessCount	Integer	O	総送信成功数
- validReadCount	Integer	O	有効既読数
- totalClickCount	Integer	O	総クリック数

ブランドメッセージ送信統計の照会

リクエスト

[URL]

Http method	URI
GET	/common/v2.2/appkeys/{appKey}/kakao-statistics/delivery-statistics/BRANDMESSAGE

[Path parameter]

名前	タイプ	説明
appKey	String	固有のアプリキー

[Header]

{
  "X-Secret-Key": String
}

名前	タイプ	必須	説明
X-Secret-Key	String	O	コンソールで作成できます。

[Query parameter]

名前	タイプ	必須	説明
senderKey	String	O	送信元キー
periodType	String	O	統計区分(DAILY：日別、MONTHLY：月別)
startDate	String	O	照会開始日 DAILY：yyyy-MM-dd(直近90日以内)、MONTHLY：yyyy-MM(直近3か月以内)
endDate	String	O	照会終了日 DAILY：yyyy-MM-dd(最大範囲90日)、MONTHLY：yyyy-MM(最大範囲3か月)
messageSpec	String	X	メッセージスペック(BASIC：基本型、FREESTYLE：自由型)
chatBubbleType	String	X	吹き出しのタイプ(TEXT：テキスト型、IMAGE：画像型、WIDE：ワイド画像型、WIDE_ITEM_LIST：ワイドアイテムリスト型、CAROUSEL_FEED：カルーセルフィード型、PREMIUM_VIDEO：プレミアム動画型、COMMERCE：コマース型、CAROUSEL_COMMERCE：カルーセルコマース型)
targeting	String	X	ターゲティング(M：マーケティング受信同意ユーザー全体、N：チャンネルフレンドを除く、I：チャンネルフレンドのみ、F：チャンネルフレンド全体)
friendType	String	X	友だちのタイプ(F：友だち、N：非友だち)
receiveUserType	String	X	受信者のタイプ(PhoneNumber：電話番号、None：受信者の識別子なし)
limit	Integer	X	照会件数(Default：500、Max：1000)
offset	Integer	X	開始位置(Default：0)

レスポンス

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "totalCount": 1,
    "brandmessageDeliveryStatistics": [
        {
            "date": "2026-04-01",
            "messageSpec": "TEMPLATE",
            "chatBubbleType": "TEXT",
            "targeting": "ALL",
            "friendType": "ALL",
            "receiveUserType": "ALL",
            "totalSendRequestCount": 200,
            "validSendRequestCount": 190,
            "validReadCount": 150,
            "totalClickCount": 60
        }
    ]
}

名前	タイプ	Not Null	説明
header	Object	O	ヘッダ領域
- resultCode	Integer	O	結果コード
- resultMessage	String	O	結果メッセージ
- isSuccessful	Boolean	O	成否
totalCount	Integer	O	総数
brandmessageDeliveryStatistics	List	O	ブランドメッセージ送信統計リスト
- date	String	O	日付
- messageSpec	String	O	メッセージスペック(BASIC：基本型、FREESTYLE：自由型)
- chatBubbleType	String	O	吹き出しのタイプ(TEXT：テキスト型、IMAGE：画像型、WIDE：ワイド画像型、WIDE_ITEM_LIST：ワイドアイテムリスト型、CAROUSEL_FEED：カルーセルフィード型、PREMIUM_VIDEO：プレミアム動画型、COMMERCE：コマース型、CAROUSEL_COMMERCE：カルーセルコマース型)
- targeting	String	O	ターゲティング(M：マーケティング受信同意ユーザー全体、N：チャンネルフレンドを除く、I：チャンネルフレンドのみ、F：チャンネルフレンド全体)
- friendType	String	O	友だちのタイプ(F：友だち、N：非友だち)
- receiveUserType	String	O	受信者のタイプ(PhoneNumber：電話番号、None：受信者の識別子なし)
- totalSendRequestCount	Integer	O	総送信リクエスト数
- validSendRequestCount	Integer	O	有効送信リクエスト数
- validReadCount	Integer	O	有効既読数
- totalClickCount	Integer	O	総クリック数

ブランドメッセージテンプレート統計の照会

リクエスト

[URL]

Http method	URI
GET	/common/v2.2/appkeys/{appKey}/kakao-statistics/template-statistics/BRANDMESSAGE

[Path parameter]

名前	タイプ	説明
appKey	String	固有のアプリキー

[Header]

{
  "X-Secret-Key": String
}

名前	タイプ	必須	説明
X-Secret-Key	String	O	コンソールで作成できます。

[Query parameter]

名前	タイプ	必須	説明
senderKey	String	O	送信元キー
periodType	String	O	統計区分(DAILY：日別、MONTHLY：月別)
startDate	String	O	照会開始日 DAILY：yyyy-MM-dd(直近90日以内)、MONTHLY：yyyy-MM(直近3か月以内)
endDate	String	O	照会終了日 DAILY：yyyy-MM-dd(最大範囲90日)、MONTHLY：yyyy-MM(最大範囲3か月)
kakaoTemplateCode	String	X	Kakaoのテンプレートコード
groupTagKey	String	X	グループタグキー
messageSpec	String	X	メッセージスペック(BASIC：基本型、FREESTYLE：自由型)
chatBubbleType	String	X	吹き出しのタイプ(TEXT：テキスト型、IMAGE：画像型、WIDE：ワイド画像型、WIDE_ITEM_LIST：ワイドアイテムリスト型、CAROUSEL_FEED：カルーセルフィード型、PREMIUM_VIDEO：プレミアム動画型、COMMERCE：コマース型、CAROUSEL_COMMERCE：カルーセルコマース型)
targeting	String	X	ターゲティング(M：マーケティング受信同意ユーザー全体、N：チャンネルフレンドを除く、I：チャンネルフレンドのみ、F：チャンネルフレンド全体)
friendType	String	X	友だちのタイプ(F：友だち、N：非友だち)
limit	Integer	X	照会件数(Default：500、Max：1000)
offset	Integer	X	開始位置(Default：0)

レスポンス

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "totalCount": 1,
    "brandmessageTemplateStatistics": [
        {
            "date": "2026-04-01",
            "templateCode": "brandtemplate01",
            "groupTagKey": "group01",
            "messageSpec": "TEMPLATE",
            "chatBubbleType": "TEXT",
            "targeting": "ALL",
            "friendType": "ALL",
            "totalSendSuccessCount": 180,
            "validReadCount": 140,
            "totalClickCount": 55
        }
    ]
}

名前	タイプ	Not Null	説明
header	Object	O	ヘッダ領域
- resultCode	Integer	O	結果コード
- resultMessage	String	O	結果メッセージ
- isSuccessful	Boolean	O	成否
totalCount	Integer	O	総数
brandmessageTemplateStatistics	List	O	ブランドメッセージテンプレート統計リスト
- date	String	O	日付
- templateCode	String	O	テンプレートコード
- groupTagKey	String	X	グループタグキー
- messageSpec	String	O	メッセージスペック(BASIC：基本型、FREESTYLE：自由型)
- chatBubbleType	String	O	吹き出しのタイプ(TEXT：テキスト型、IMAGE：画像型、WIDE：ワイド画像型、WIDE_ITEM_LIST：ワイドアイテムリスト型、CAROUSEL_FEED：カルーセルフィード型、PREMIUM_VIDEO：プレミアム動画型、COMMERCE：コマース型、CAROUSEL_COMMERCE：カルーセルコマース型)
- targeting	String	O	ターゲティング(M：マーケティング受信同意ユーザー全体、N：チャンネルフレンドを除く、I：チャンネルフレンドのみ、F：チャンネルフレンド全体)
- friendType	String	O	友だちのタイプ(F：友だち、N：非友だち)
- totalSendSuccessCount	Integer	O	総送信成功数
- validReadCount	Integer	O	有効既読数
- totalClickCount	Integer	O	総クリック数

Notification > KakaoTalk Bizmessage > Common > API v2.2 Guide
統計
[APIドメイン]
統計検索 - イベントベース
統計情報照会
イベント別数照会
Kakao統計
送信統計
テンプレート統計
お知らせトーク送信統計の照会
お知らせトークテンプレート統計の照会
ブランドメッセージ送信統計の照会
ブランドメッセージテンプレート統計の照会

TOP

Notification > KakaoTalk Bizmessage > Common > API v2.2 Guide

統計

[APIドメイン]

統計検索 - イベントベース

統計情報照会

イベント別数照会

Kakao統計

送信統計

テンプレート統計

お知らせトーク送信統計の照会

リクエスト

レスポンス

お知らせトークテンプレート統計の照会

リクエスト

レスポンス

ブランドメッセージ送信統計の照会

リクエスト

レスポンス

ブランドメッセージテンプレート統計の照会

リクエスト

レスポンス

目次