Consulter le statut de traitement d’une requête

Utilisez cet endpoint pour vérifier si Braze a terminé le traitement d’un groupe de requêtes asynchrones de l’endpoint /users/track.

Important

Cet endpoint est en version bêta. Si vous souhaitez participer à la bêta, contactez votre gestionnaire de compte Braze.

Une réponse réussie de /users/track signifie que Braze a reçu votre requête et l’a mise en file d’attente pour traitement. Pour confirmer que le traitement est terminé, incluez le même group_id dans chaque requête /users/track associée, puis appelez cet endpoint avec ce group_id. Lorsque le status du groupe est completed, vous pouvez effectuer en toute sécurité des actions dépendant de ces données, comme déclencher un Canvas ou lancer une campagne.

Pour le flux de travail complet, les exigences relatives à l’ID de groupe, les limites et la rétention, consultez Suivi du statut de traitement des requêtes.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec la permission users.track.status. La permission users.track n’inclut pas l’accès à cet endpoint.

Toute clé API de l’espace de travail disposant de la permission users.track.status peut consulter n’importe quel groupe dans cet espace de travail, indépendamment de la clé API ayant envoyé les requêtes /users/track.

Limite de débit

Braze applique une limite de débit de 1 500 requêtes par minute et par espace de travail à cet endpoint, comme documenté dans Limites de débit de l’API. Cette limite est distincte de la limite de débit de /users/track.

Les réponses réussies incluent les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset afin que vous puissiez suivre la capacité restante de votre fenêtre en cours.

Paramètres de requête

Exemple de requête

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'

Réponse

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".
    }
  ]
}

Le tableau results contient un objet lorsque Braze trouve le groupe. Il est vide lorsque le groupe n’existe pas dans l’espace de travail ou que sa période de rétention de 24 heures est expirée. Braze renvoie un tableau results vide dans les deux cas, donc un tableau vide ne vous indique pas si un groupe a existé ou non.

Paramètres de réponse

Un statut completed signifie que Braze a terminé le traitement de chaque requête du groupe, y compris les requêtes pour lesquelles Braze a rejeté certains objets. Cet endpoint ne rapporte que le nombre de requêtes et ne fournit pas les résultats pour les attributs, événements ou achats individuels. Pour trouver les objets rejetés, vérifiez le tableau errors dans chaque réponse /users/track.

Exemples de réponses

Groupe encore en cours de traitement

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
    }
  ]
}

Groupe terminé

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"
    }
  ]
}

Groupe non trouvé ou expiré

1
2
3

{
  "results": []
}

Résolution des problèmes

Le tableau suivant répertorie les erreurs que cet endpoint peut renvoyer et comment les résoudre.

Pour les autres codes de statut et messages d’erreur, consultez Erreurs fatales et réponses.