ROrossum
Rules Execution Log

List rules execution logs

Changed on

List rules execution logs with optional filters and pagination.

Returns paginated rule execution records (controlled by page_size), including trigger conditions, evaluation results, and executed actions.

get/api/v1/rules_execution_logs

Request

Query parameters

created_at_afterstring date-time

Created after filter.

created_at_beforestring date-time

Created before filter.

rulestring

Filter by rule ID (or multiple IDs, comma-separated).

annotationinteger[]

Annotation ID(s) filter

queueinteger[]

Queue ID(s) filter

request_idstring

Filter by exact request ID.

execution_result'success' | 'failure' | 'partial_success'

Filter by execution result (or multiple values, comma-separated).

trigger_eventstring

Filter by trigger event (or multiple events, comma-separated).

trigger_matchboolean

Filter by trigger result. true means the trigger condition evaluated to true for at least one line.

searchstring

Full text search across log entry fields.

page_sizeinteger

Maximum number of results per page (between 1 and 100, defaults to 100).

Response

OK

Example response

{
  "results": [
    {
      "rule_id": 123,
      "rule_name": "Auto-confirm invoices over $1000",
      "queue_id": 456,
      "annotation_id": 789,
      "request_id": "6166deb3-2f89-4fc2-9359-56cc8e3838e4",
      "created_at": "2024-01-15T10:30:00.000000Z",
      "trigger_event": "annotation_imported",
      "trigger_condition": "field.amount_total > 1000",
      "trigger_condition_results": [
        true
      ],
      "trigger_condition_values": [
        {
          "amount_total": "1500.00"
        }
      ],
      "trigger_match": true,
      "execution_result": "success",
      "actions": [
        [
          {
            "action_id": "a1",
            "action_type": "send_email",
            "execution_result": "success",
            "execution_error": null,
            "payload": {
              "to": [
                "accountant@example.com"
              ],
              "cc": [
                "manager@example.com"
              ],
              "subject": "Invoice processed",
              "body": "Invoice has been processed successfully.",
              "attach_document": true
            }
          },
          {
            "action_id": "a2",
            "action_type": "add_label",
            "execution_result": "success",
            "execution_error": null,
            "payload": {
              "labels": [
                "https://example.rossum.app/api/v1/labels/123"
              ]
            }
          },
          {
            "action_id": "a3",
            "action_type": "change_status",
            "execution_result": "success",
            "execution_error": null,
            "payload": {
              "method": "postpone"
            }
          }
        ]
      ]
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • info

      added the new optional query request parameter trigger_match

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status