Sign in
Rules

List rule evaluations

Returns a paginated list of rule evaluation records for the specified grant. Each record captures which rules were evaluated against an inbound message, SMTP envelope, or outbound send, the normalized sender or recipient data that was matched, which rules matched, and which actions were applied.

Rule evaluations are created automatically as inbound mail is processed and as outbound sends are evaluated, and serve as an audit trail for the Rules engine. Records are returned in reverse chronological order (most recent first).

get/v3/grants/{grant_id}/rule-evaluations

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

A cursor to fetch the next page of results. Use the next_cursor value from the previous response.

Response

OK

request_idstring

ID of the request.

next_cursorstring

A cursor for paginating through results. Present when there are more results; pass this value as page_token in the next request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "grant_id": "41009df5-bf11-4c97-aa18-b285b5f2e386",
      "message_id": "e8b5a51d-3c2f-4a1e-9d7b-6f8c2e1a4b3d",
      "evaluated_at": 1713000000,
      "evaluation_stage": "inbox_processing",
      "evaluation_input": {
        "from_address": "sender@example.com",
        "from_domain": "example.com",
        "from_tld": "com",
        "recipient_addresses": [
          "recipient@example.com",
          "bcc@example.net"
        ],
        "recipient_domains": [
          "example.com",
          "example.net"
        ],
        "recipient_tlds": [
          "com",
          "net"
        ],
        "outbound_type": "reply"
      },
      "applied_actions": {
        "blocked": true,
        "folder_ids": [
          "4f2e1a0d-c3b2-4a5e-8d9c-6f8b2e1a4b3d"
        ]
      },
      "matched_rule_ids": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "application_id": "5f37fe8d-c4ba-4898-bc18-aad5bb34735e",
      "organization_id": "9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210",
      "created_at": 1713000000,
      "updated_at": 1713000000
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiYjIzZGM0NWUtNjdmOC05MDEyLWJjZGUtMzQ1Njc4OWFiY2RmIn0="
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.