メインコンテンツへスキップ
POST
get-campaign-statistics
前日分のデータを確認する時間前日分のデータは午前7時(KST)以降に確認してください。
集計日日別データは、各イベントが発生した日付で集計、表示されます。たとえば、7月23日に送信したキャンペーンで7月24日にクリックが発生した場合、送信イベントは7月23日、クリックイベントは7月24日の集計に含まれます。
メッセージ統計の詳細取得との違いメッセージ統計の詳細取得では、キャンペーンの指定が必要です。このAPIは、指定期間に集計されたキャンペーンとユーザージャーニーの日別件数を返します。tagsを指定した場合は、指定したタグのいずれかに一致するキャンペーンのみが返され、ユーザージャーニーは含まれません。

承認

Authorization
string
header
必須

POST /authenticateで発行したトークンをBearer形式で送信します。

パスパラメータ

projectId
string
必須

プロジェクトIDです。

ボディ

application/json
start
string<date>
必須

集計対象の開始日です。韓国標準時(KST)のyyyy-MM-dd形式で指定します。

end
string<date>
必須

集計対象の終了日です。韓国標準時(KST)のyyyy-MM-dd形式で指定します。リクエスト当日は対象外です。

tags

タグの配列またはカンマ区切りの文字列です。いずれかのタグに一致するキャンペーンが対象で、ユーザージャーニーは除外されます。

レスポンス

統計を取得しました。

date
string<date>

統計データの日付です。形式はYYYY-MM-DDです。

resource_type
enum<string>

リソースのタイプです。

利用可能なオプション:
campaign,
user_journey
message
object | null

メッセージの内容です。構造はチャネルによって異なります。

campaign_id
string | null

キャンペーンIDです。キャンペーンリソースの場合のみ存在します。

campaign_name
string | null

キャンペーン名です。キャンペーンリソースの場合のみ存在します。

variant_id
string | null

キャンペーンのA/BテストのバリアントIDです。バリアントIDがないキャンペーン行ではnullになります。

variant_name
string | null

キャンペーンのA/Bテストのバリアント名です。バリアント名がないキャンペーン行ではnullになります。

tags
string[]

キャンペーンタグのリストです。

user_journey_id
string | null

ユーザージャーニーIDです。ユーザージャーニーリソースの場合のみ存在します。

user_journey_name
string | null

ユーザージャーニー名です。ユーザージャーニーリソースの場合のみ存在します。

user_journey_node_id
string | null

ユーザージャーニーのノードIDです。ユーザージャーニーリソースの場合のみ存在します。

user_journey_node_name
string | null

ユーザージャーニーのノード名です。ユーザージャーニーリソースの場合のみ存在します。

channel
string

送信チャネルの情報です。

channel_subtype
string | null

配信チャネルのサブタイプです。

brand_message_target
string | null

カカオブランドメッセージの対象です。

message_sent
integer | null

送信成功数です。ポップアップでは表示回数です。チャネルが未対応の場合はnullです。

message_failed
integer | null

送信失敗数です。チャネルが未対応の場合はnullです。

delivered
integer | null

受信者に到達したメッセージ数です。チャネルがこの指標に対応していない場合はnullです。

click
integer | null

クリックされたメッセージ数です。チャネルがこの指標に対応していない場合はnullです。

conversion
object[]

コンバージョンデータの配列です。