Réponse exemple
GET/v1/rules/{id}/executionsHistorique paginé des exécutions d'une règle d'automatisation.Cet endpoint retourne l'historique d'exécution d'une règle d'automatisation identifiée par {id}. Chaque ligne représente une exécution déclenchée par un événement (par exemple un transfert créé ou complété) et indique son statut, l'action effectuée, l'entité concernée, ainsi que la durée et, le cas échéant, le message d'erreur. Les résultats sont triés du plus récent au plus ancien (created_at décroissant). La règle doit appartenir au workspace de la clé API : un identifiant inconnu ou appartenant à un autre workspace renvoie une erreur 404.
Authentification
Requiert une clé API valide avec le scope transfers:read. La requête est authentifiée via l'en-tête Authorization: Bearer <clé>. Si la clé ne porte pas ce scope, l'API renvoie une erreur 403 avec le code scope_missing.
Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| limit | integer | Non | Nombre maximum d'exécutions à retourner. Borné entre 1 et 100. Valeur par défaut : 20. |
| offset | integer | Non | Décalage de pagination (nombre d'éléments à ignorer). Minimum 0. Valeur par défaut : 0. |
L'identifiant de règle est passé dans le chemin ({id}) et non en paramètre de requête.
Réponse
La réponse est un objet liste (object: "list") contenant un tableau data, le nombre total d'exécutions (total), ainsi que les valeurs limit et offset appliquées. Chaque élément de data expose les champs suivants : id (identifiant de l'exécution), rule_id, status (par exemple success ou failed), action_type (type d'action exécutée), entity_id (entité ciblée, par exemple un transfert), event (événement déclencheur), error_message (null si succès), duration_ms (durée d'exécution en millisecondes) et created_at (horodatage ISO 8601).
| Champ | Type | Description |
|---|---|---|
| object | string | Toujours "list". |
| data | array | Tableau des exécutions, du plus récent au plus ancien. |
| data[].id | string | Identifiant unique de l'exécution. |
| data[].rule_id | string | Identifiant de la règle exécutée. |
| data[].status | string | Statut de l'exécution (ex. success, failed). |
| data[].action_type | string | Type d'action déclenchée par la règle. |
| data[].entity_id | string | Identifiant de l'entité concernée par l'exécution. |
| data[].event | string | Événement ayant déclenché l'exécution. |
| data[].error_message | string | null | Message d'erreur en cas d'échec, sinon null. |
| data[].duration_ms | integer | Durée de l'exécution en millisecondes. |
| data[].created_at | string | Horodatage ISO 8601 de l'exécution. |
| total | integer | Nombre total d'exécutions pour cette règle. |
| limit | integer | Limite effectivement appliquée. |
| offset | integer | Décalage effectivement appliqué. |
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 404 not_found | La règle {id} n'existe pas ou n'appartient pas au workspace de la clé API. | Vérifiez l'identifiant de la règle et que la clé API correspond bien au bon workspace. |
| 403 scope_missing | La clé API ne possède pas le scope transfers:read. | Émettez ou utilisez une clé API portant le scope transfers:read. |
| 401 invalid_api_key | La clé API est absente, invalide, expirée ou révoquée. | Fournissez une clé valide via l'en-tête Authorization: Bearer. |
| 429 rate_limited | Le quota de requêtes par minute du workspace est dépassé. | Respectez l'en-tête Retry-After avant de réessayer. |
| 500 internal_error | Erreur interne lors de la lecture de l'historique. | Réessayez plus tard ; conservez le X-Request-Id pour le support. |
Voir aussi
- GET /v1/rules/{id} — récupérer la configuration d'une règle d'automatisation.
- GET /v1/rules — lister les règles du workspace.
- GET /v1/transfers/{id} — consulter le transfert ciblé par une exécution via
entity_id.