Skip to main content

GET /alerts/{id}/log

GET 

alerts/:id/log

Retrieve the event logs triggered by a specific alert rule

Path Parameters​

id string Required
User alert ID

Query Parameters​

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

sort string
Example: -timestamp (desc) or timestamp (asc)

Returns

  • dataarray
    • idstring
      Unique identifier of the triggered alert log entry
    • profile_idstring
      Profile ID associated with this alert occurrence
    • user_alert_idstring
      Reference to the parent user alert configuration
    • namestring
      Name of the alert that was triggered
    • rulesarray
      Array of alert rules with their trigger details and matched conditions
      • typestring
        Type of alert rule that was triggered
      • snapshotobject
        Snapshot of data at the time the alert was triggered (e.g., current reputation scores, RBL status)
      • matchingsobject
        Details of what matched the alert rule conditions (e.g., specific IPs, domains, or values that triggered the alert)
    • timestampstring
      Timestamp when the alert was triggered
  • metaobject
    Pagination metadata for list responses
    • countinteger
      Total number of items available
    • offsetinteger
      Number of items skipped
    • limitinteger
      Maximum number of items returned per request
Error Codes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error