Skip to content

エクスポートエンドポイント

このエンドポイントコレクションを使用すると、KPI、アプリセッション、ユーザー、セグメント、キャンペーン、キャンバスに関するさまざまなレベルの詳細にアクセスしてエクスポートできます。パラメーターとリクエストボディを作成する際には、BrazeインスタンスAPIキー、およびAPI識別子を確認してください。

前提条件

開始する前に、以下を準備してください。

要件 説明
Braze REST APIキー 呼び出す予定のエンドポイントに対する適切なエクスポート権限を持つREST APIキー。APIキーは特定のエンドポイントにスコープされ、作成後に権限を変更することはできません。詳細については、REST APIキーを参照してください。
関連する識別子 エクスポートしたいデータの識別子(キャンペーン ID、セグメント ID、キャンバス IDなど)。これらはBrazeダッシュボードで確認できます。完全なリストについては、API識別子タイプを参照してください。
クラウドストレージの認証情報(オプション) 大規模なデータセットをエクスポートする場合は、Amazon S3Microsoft Azure Blob Storage、またはGoogle Cloud Storageバケットを接続して、エクスポートファイルをストレージに直接書き込むことができます。

エクスポートできるデータ

以下の表は、エクスポートAPIで利用可能なデータカテゴリをまとめたものです。

カテゴリ 含まれるデータ APIリファレンス
キャンペーン パフォーマンス分析、キャンペーンの詳細、キャンペーンリスト、送信分析 キャンペーンエンドポイント
キャンバス データシリーズ分析、分析サマリー、キャンバスの詳細、キャンバスリスト キャンバスエンドポイント
セグメント セグメントリスト、セグメント分析、セグメントの詳細 セグメントエンドポイント
ユーザーデータ 識別子またはセグメント別の完全なユーザープロファイル、グローバルコントロールグループ別のユーザー ユーザーデータエンドポイント
KPI デイリーアクティブユーザー、月間アクティブユーザー、日次新規ユーザー、日付別アンインストール KPIエンドポイント
セッション アプリセッションの時系列データ セッションエンドポイント
カスタムイベント イベント名、イベントリスト、時系列のイベント分析 カスタムイベントエンドポイント
カスタム属性 属性名 カスタム属性エンドポイント
購入 時間別収益データ、製品IDリスト、購入数 購入エンドポイント

エクスポートデータの配信方法

APIエクスポートは、ダッシュボードからダウンロードするCSVファイルとは異なり、JSON形式でデータを返します。配信方法は、クラウドストレージが接続されているかどうかによって異なります。

  • クラウドストレージなしの場合: BrazeはエクスポートファイルをBraze独自のS3バケットに書き込み、APIレスポンスに一時的なダウンロードURLを含めます。このURLは4時間後に期限切れになり、エクスポートはJSONファイルを含む圧縮アーカイブ(output_formatパラメーターに応じてZIPまたはGZIP)としてパッケージされます。JSONファイルの各行は1つのデータオブジェクトを表します。
  • クラウドストレージ接続済みの場合: Brazeはエクスポートファイルを設定済みのバケットに直接書き込みます。APIレスポンスにはダウンロードURLは含まれません。ファイルは独自の保持ポリシーに従い、大規模なエクスポートではより信頼性が高くなります。

エクスポートの配信とトラブルシューティングの詳細については、エクスポートのトラブルシューティングを参照してください。

エクスポートエンドポイント一覧

以下の表は、利用可能なすべてのエクスポートAPIを一覧にしたものです。

カテゴリ メソッド エンドポイント
キャンペーン GET キャンペーン分析
キャンペーン GET キャンペーンの詳細
キャンペーン GET キャンペーンリスト
キャンペーン GET 送信分析
キャンバス GET キャンバスデータシリーズ分析
キャンバス GET キャンバス分析サマリー
キャンバス GET キャンバスの詳細
キャンバス GET キャンバスリスト
カスタムイベント GET カスタムイベント
カスタムイベント GET カスタムイベントリスト
カスタムイベント GET カスタムイベント分析
カスタム属性 GET カスタム属性
KPI GET 日付別の日次新規ユーザーKPI
KPI GET 日付別のデイリーアクティブユーザーKPI
KPI GET 過去30日間の月間アクティブユーザーKPI
KPI GET 日付別のアンインストールKPI
購入 GET 製品IDリスト
購入 GET 購入数
購入 GET 時間別収益データ
セグメント GET セグメントリスト
セグメント GET セグメント分析
セグメント GET セグメントの詳細
セッション GET アプリセッションの時系列データ
ユーザーデータ POST 識別子によるユーザーデータ
ユーザーデータ POST セグメントによるユーザーデータ
ユーザーデータ POST グローバルコントロールグループによるユーザーデータ

ダッシュボードからの単発エクスポートについては、以下の記事を参照してください。

New Stuff!