Skip to main content
GET
/
v1
/
alerts
/
executions
/
{execution_id}
Get Alert Execution
curl --request GET \
  --url https://api.mixpeek.com/v1/alerts/executions/{execution_id}
{
  "alert_id": "<string>",
  "collection_id": "<string>",
  "triggered": true,
  "match_count": 1,
  "executed_at": "<string>",
  "duration_ms": 1,
  "execution_id": "<string>",
  "matches": [
    {
      "document_id": "<string>",
      "score": 0.5,
      "asset_id": "<string>",
      "matched_features": {},
      "metadata": {}
    }
  ],
  "source_documents": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
execution_id
string
required

Execution ID (exec_...)

Response

Successful Response

Result of an alert execution.

Captures the outcome of running an alert against one or more documents, including whether the alert was triggered and what matched.

Attributes: alert_id: ID of the alert that was executed collection_id: Collection the alert was executed against execution_id: Unique identifier for this execution triggered: Whether the alert was triggered (i.e., retriever returned results) match_count: Number of matches found matches: List of match results (if include_matches was True) source_documents: Document IDs that triggered the alert check executed_at: When the alert was executed duration_ms: How long the execution took

​
alert_id
string
required

ID of the alert that was executed

​
collection_id
string
required

Collection the alert was executed against

​
triggered
boolean
required

Whether the alert was triggered

​
match_count
integer
required

Number of matches found

Required range: x >= 0
​
executed_at
string
required

ISO 8601 timestamp when the alert was executed

​
duration_ms
integer
required

How long the execution took in milliseconds

Required range: x >= 0
​
execution_id
string

Unique identifier for this execution

​
matches
AlertMatchResult · object[] | null

List of match results

​
source_documents
string[]

Document IDs that triggered the alert check