リクエスト処理ステータスの検索

このエンドポイントを使用して、非同期の/users/trackエンドポイントリクエストグループの処理がBrazeで完了したかどうかを確認します。

重要

このエンドポイントはベータ版です。ベータへの参加に興味がある場合は、Brazeアカウントマネージャーにお問い合わせください。

/users/track からの成功レスポンスは、Brazeがリクエストを受信し、処理のためにキューに入れたことを意味します。処理が完了したことを確認するには、関連する各 /users/track リクエストに同じ group_id を含め、その group_id を使用してこのエンドポイントを呼び出します。グループの status が completed の場合、キャンバスのトリガーやキャンペーンの開始など、そのデータに依存するアクションを安全に実行できます。

完全なワークフロー、グループID要件、制限、およびリテンションについては、リクエスト処理ステータスの追跡を参照してください。

前提条件

このエンドポイントを使用するには、users.track.status 権限を持つAPIキーが必要です。users.track 権限にはこのエンドポイントへのアクセスは含まれていません。

ワークスペース内の users.track.status 権限を持つ任意のAPIキーで、そのワークスペース内の任意のグループを検索できます。どのAPIキーが /users/track リクエストを送信したかは問いません。

レート制限

Brazeは、APIレート制限に記載されているように、このエンドポイントに対してワークスペースあたり1分あたり1,500リクエストのレート制限を適用します。この制限は/users/trackのレート制限とは別のものです。

成功したレスポンスにはX-RateLimit-Limit、X-RateLimit-Remaining、およびX-RateLimit-Resetヘッダーが含まれるため、現在のウィンドウの残量を追跡できます。

クエリパラメーター

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/users/track/status?group_id=loyalty_backfill_2026-09-23' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

1
2
3
4
5
6
7
8
9
10
11
12

{
  "results": [
    {
      "group_id": (string) the group ID from your request,
      "status": (string) the processing status of the group, either "processing" or "completed",
      "received": (integer) the number of /users/track requests Braze accepted for this group,
      "done": (integer) the number of accepted requests Braze has finished processing,
      "processing": (integer) the number of accepted requests Braze is still processing,
      "final_completion_time": (string or null) when the last request in the group finished processing, in ISO 8601 format (UTC). This is null until the status is "completed".
    }
  ]
}

results 配列には、Brazeがグループを見つけた場合に1つのオブジェクトが含まれます。ワークスペースにグループが存在しない場合、または24時間の保持期間が終了した場合は空になります。Brazeはどちらの場合も空の results 配列を返すため、空の配列からグループがかつて存在したかどうかを判断することはできません。

レスポンスパラメーター

completed ステータスは、Brazeが一部のオブジェクトを拒否したリクエストを含め、グループ内のすべてのリクエストの処理を完了したことを意味します。このエンドポイントはリクエスト数のみを報告し、個々の属性、イベント、または購入の結果は報告しません。拒否されたオブジェクトを確認するには、各 /users/track レスポンスの errors 配列を確認してください。

レスポンス例

グループがまだ処理中

1
2
3
4
5
6
7
8
9
10
11
12

{
  "results": [
    {
      "group_id": "loyalty_backfill_2026-09-23",
      "status": "processing",
      "received": 4,
      "done": 3,
      "processing": 1,
      "final_completion_time": null
    }
  ]
}

グループの処理が完了

1
2
3
4
5
6
7
8
9
10
11
12

{
  "results": [
    {
      "group_id": "loyalty_backfill_2026-09-23",
      "status": "completed",
      "received": 4,
      "done": 4,
      "processing": 0,
      "final_completion_time": "2026-09-23T18:58:57.123Z"
    }
  ]
}

グループが見つからないか期限切れ

1
2
3

{
  "results": []
}

トラブルシューティング

次の表に、このエンドポイントが返す可能性のあるエラーとその解決方法を示します。

その他のステータスコードとエラーメッセージについては、致命的なエラーとレスポンスを参照してください。