Alerts

Get Alert Execution

Changed on

Get a single alert execution result by execution ID. Use this to poll for alert results without needing a webhook.

get/v1/alerts/executions/{execution_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/alerts/executions/{execution_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

execution_idstring required

Execution ID (exec_...)

Response

Successful Response

alert_idstring required

ID of the alert that was executed

collection_idstring required

Collection the alert was executed against

execution_idstring

Unique identifier for this execution

triggeredboolean required

Whether the alert was triggered

match_countinteger required

Number of matches found

source_documentsstring[]

Document IDs that triggered the alert check

executed_atstring required

ISO 8601 timestamp when the alert was executed

duration_msinteger required

How long the execution took in milliseconds

Changes

  • 790bc16455f6Revision changes
    • info

      added the optional property to the response with the status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status