Référence APILister l'historique d'exécution d'une règle
GET/v1/rules/{id}/executions

Lister l'historique d'exécution d'une règle

Renvoie l'historique paginé des exécutions d'une règle d'automatisation, de la plus récente à la plus ancienne.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"data": [
{
"id": "rexec_8sJ2k1Lp9Qv",
"event": "transfer.completed",
"status": "success",
"rule_id": "rule_2aZ7mK4dW",
"entity_id": "txfr_9Kd2LpQ7",
"created_at": "2026-06-05T09:41:18.503Z",
"action_type": "send_notification",
"duration_ms": 142,
"error_message": null
},
{
"id": "rexec_3mN0bV6tHc",
"event": "transfer.created",
"status": "failed",
"rule_id": "rule_2aZ7mK4dW",
"entity_id": "txfr_4Bq8RtY1",
"created_at": "2026-06-05T08:12:54.117Z",
"action_type": "webhook",
"duration_ms": 2031,
"error_message": "Webhook endpoint returned 503"
}
],
"limit": 20,
"total": 47,
"object": "list",
"offset": 0
}
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ètreTypeRequisDescription
limitintegerNonNombre maximum d'exécutions à retourner. Borné entre 1 et 100. Valeur par défaut : 20.
offsetintegerNonDé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).

ChampTypeDescription
objectstringToujours "list".
dataarrayTableau des exécutions, du plus récent au plus ancien.
data[].idstringIdentifiant unique de l'exécution.
data[].rule_idstringIdentifiant de la règle exécutée.
data[].statusstringStatut de l'exécution (ex. success, failed).
data[].action_typestringType d'action déclenchée par la règle.
data[].entity_idstringIdentifiant de l'entité concernée par l'exécution.
data[].eventstringÉvénement ayant déclenché l'exécution.
data[].error_messagestring | nullMessage d'erreur en cas d'échec, sinon null.
data[].duration_msintegerDurée de l'exécution en millisecondes.
data[].created_atstringHorodatage ISO 8601 de l'exécution.
totalintegerNombre total d'exécutions pour cette règle.
limitintegerLimite effectivement appliquée.
offsetintegerDécalage effectivement appliqué.

Erreurs

CodeQuandRésolution
404 not_foundLa 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_missingLa clé API ne possède pas le scope transfers:read.Émettez ou utilisez une clé API portant le scope transfers:read.
401 invalid_api_keyLa clé API est absente, invalide, expirée ou révoquée.Fournissez une clé valide via l'en-tête Authorization: Bearer.
429 rate_limitedLe quota de requêtes par minute du workspace est dépassé.Respectez l'en-tête Retry-After avant de réessayer.
500 internal_errorErreur interne lors de la lecture de l'historique.Réessayez plus tard ; conservez le X-Request-Id pour le support.

Voir aussi