コンテンツにスキップ

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

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

前提条件

始める前に、以下が揃っていることを確認してください。

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

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

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

カテゴリ 含まれる内容 APIリファレンス
キャンペーン パフォーマンス分析、キャンペーンの詳細、キャンペーン一覧、送信分析 キャンペーンエンドポイント
キャンバス データシリーズ分析、分析サマリー、キャンバスの詳細、キャンバス一覧 キャンバスエンドポイント
セグメント セグメント一覧、セグメント分析、セグメントの詳細 セグメントエンドポイント
ユーザーデータ 識別子またはセグメント別の完全なユーザープロファイル、グローバルコントロールグループ別のユーザー ユーザーデータエンドポイント
KPIs デイリーアクティブユーザー、マンスリーアクティブユーザー、デイリー新規ユーザー、日付別のアンインストール数 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 カスタム属性
KPIs GET 日別新規ユーザーのKPIs
KPIs GET 日別アクティブユーザーのKPIs
KPIs GET 過去30日間の月間アクティブユーザーのKPIs
KPIs GET 日別アンインストールのKPIs
購入 GET 商品ID一覧
購入 GET 購入数
購入 GET 時系列の収益データ
セグメント GET セグメント一覧
セグメント GET セグメント分析
セグメント GET セグメントの詳細
セッション GET アプリセッション時系列データ
ユーザーデータ POST 識別子によるユーザーデータ
ユーザーデータ POST セグメントによるユーザーデータ
ユーザーデータ POST グローバルコントロールグループによるユーザーデータ

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

New Stuff!