Executions API

The Executions API provides read-only access to the history of rule executions. Use it to inspect what happened during each run, filter by status or rule, and debug failures.

All endpoints are under /api/executions and require authentication.

Endpoints

GET/api/executionsAuth required

List executions with optional filters and pagination.

Query parameters

Parameter	Type	Description
`ruleId`	string	Filter by a specific rule ID
`status`	string	Filter by status (e.g. `success`, `failed`, `skipped`)
`page`	number	Page number (default: 1)
`pageSize`	number	Results per page (default: 20)


GET /api/executions?ruleId=rule_abc&status=failed&page=1&pageSize=25

Example response


{
  "executions": [
    {
      "id": "exec_xyz789",
      "ruleId": "rule_abc123",
      "status": "success",
      "startedAt": "2026-04-30T09:00:00Z",
      "completedAt": "2026-04-30T09:00:02Z",
      "trigger": "push",
      "actions": ["notify", "label"]
    }
  ],
  "total": 342,
  "page": 1,
  "pageSize": 25
}

GET/api/executions/:idAuth required

Get full details of a single execution including action results.

Example response


{
  "id": "exec_xyz789",
  "ruleId": "rule_abc123",
  "status": "success",
  "startedAt": "2026-04-30T09:00:00Z",
  "completedAt": "2026-04-30T09:00:02Z",
  "trigger": "push",
  "context": {
    "repo": "acme/api",
    "branch": "feature/payments",
    "author": "dev@acme.com"
  },
  "actions": [
    { "type": "notify", "status": "delivered", "target": "#ops" },
    { "type": "label", "status": "applied", "label": "needs-review" }
  ]
}

Executions are retained for 30 days on the Free plan, 90 days on Pro, and unlimited on Team and Business.