Skip to main content
GET
/
v1
/
alerts
/
executions
List All Executions
curl --request GET \
  --url https://api.mixpeek.com/v1/alerts/executions \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 500,
  "offset": 5000,
  "cursor": "<string>",
  "include_total": false
}
'
{
  "results": [
    {
      "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>"
      ]
    }
  ],
  "pagination": {},
  "total_count": 123
}

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"

​
X-Namespace
string

REQUIRED: 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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Query Parameters

​
total
integer | null
​
next_cursor
string | null
​
base_url
string | null

Body

application/json

PaginationParams.

Pagination modes:

  • Cursor-based (recommended): Use limit + cursor for efficient pagination at any depth
  • Offset-based (legacy): Use limit + offset (inefficient for deep pagination, max offset 10000)

Cursor pagination:

  • First page: omit cursor or use cursor=None
  • Subsequent pages: use next_cursor from previous response
  • No limit on pagination depth
  • Preferred for MongoDB (objects)

Offset pagination:

  • Use offset + limit (legacy, kept for backward compatibility)
  • Limited to offset < 10000
  • Used by some endpoints (namespaces, collections, etc.)

Total count:

  • Use include_total=true to get total count (expensive, adds 50-200ms)
  • Default: include_total=false (no COUNT query)
​
limit
integer | null
Required range: 1 <= x <= 1000
​
offset
integer | null

Offset for pagination (legacy, use cursor instead). Limited to 10000 for performance.

Required range: 0 <= x <= 10000
​
cursor
string | null
​
include_total
boolean
default:false

Include total_count in response (expensive operation, adds 50-200ms)

Response

Successful Response

Response model for listing alert executions.

​
results
AlertExecutionResult · object[]
required

List of execution results

​
pagination
Pagination · object
required

Pagination information

​
total_count
integer
required

Total number of executions