List Alerts

List all alerts in the namespace with optional filtering and pagination.

Filtering:

• Use search for wildcard text search across alert_id, name, description
• Use filters for structured queries

Sorting:

• Default: created_at descending (newest first)

POST /v1/alerts/list

List Alerts

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/alerts/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "search": "<string>",
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "case_sensitive": false
}
'

200

{
  "results": [
    {
      "name": "<string>",
      "notification_config": {
        "channels": [
          {
            "channel_type": "<string>",
            "channel_id": "wh_safety_team",
            "config": {
              "url": "https://example.com/webhook"
            }
          }
        ],
        "include_matches": true,
        "include_scores": true,
        "template_id": "<string>"
      },
      "alert_id": "<string>",
      "namespace_id": "ns_production",
      "description": "Alerts when new videos match known safety incidents",
      "source": "retriever",
      "retriever_id": "ret_safety_search",
      "trigger_on": "results",
      "system_condition": {
        "params": {}
      },
      "namespace_selector": {
        "mode": "all",
        "namespace_ids": [
          "<string>"
        ]
      },
      "enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "total_count": 123,
  "stats": {
    "total_alerts": 0,
    "enabled_alerts": 0,
    "disabled_alerts": 0,
    "alerts_by_channel_type": {}
  }
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Query Parameters

limit · integer | null

Required range: 1 <= x <= 1000

page_size · integer | null

Required range: 1 <= x <= 1000

offset · integer | null

Required range: 0 <= x <= 10000

page · integer | null

Required range: x >= 1

cursor · string | null

next_cursor · string | null

after · string | null

include_total · boolean · default: false

Body

application/json

Request model to list alerts.

search · string | null

Search term for wildcard search across alert_id, name, description

filters · LogicalOperator · object | null

Filters to apply to the alert list

Show child attributes

sort · SortOption · object | null

Sort configuration for the alert list

Show child attributes

case_sensitive · boolean · default: false

If True, filters and search will be case-sensitive

Response

200

application/json

Successful Response

Response model for listing alerts.

results · AlertResponse · object[] · required

List of alerts

Show child attributes

pagination · PaginationResponse · object · required

Pagination information

Show child attributes

total_count · integer · required

Total number of alerts matching query

stats · AlertListStats · object | null

Aggregate statistics across all alerts in the result

Show child attributes