Skip to main content
POST
/
v1
/
triggers
/
list
List Triggers
curl --request POST \
  --url https://api.mixpeek.com/v1/triggers/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_id": "<string>",
  "offset": 0,
  "limit": 50,
  "sort_by": "created_at",
  "direction": "desc"
}
'
{
  "results": [
    {
      "namespace_id": "<string>",
      "internal_id": "<string>",
      "action_config": {},
      "schedule_config": {},
      "trigger_id": "<string>",
      "status": "active",
      "last_triggered_at": "2023-11-07T05:31:56Z",
      "last_execution_task_id": "<string>",
      "next_scheduled_at": "2023-11-07T05:31:56Z",
      "execution_count": 0,
      "consecutive_failures": 0,
      "last_execution_status": "<string>",
      "last_execution_error": "<string>",
      "event_counter": 0,
      "last_cooldown_at": "2023-11-07T05:31:56Z",
      "baseline_snapshot": {},
      "last_drift_measurement": {},
      "last_condition_check_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to list triggers with filters.

action_type
enum<string> | null

Filter by action type

Available options:
cluster,
taxonomy_enrichment,
batch_rerun,
collection_trigger
trigger_type
enum<string> | null

Filter by trigger type

Available options:
cron,
interval,
event,
conditional
status
enum<string> | null

Filter by status

Available options:
active,
paused,
disabled,
failed
resource_id
string | null

Filter by resource ID (cluster_id or taxonomy_id)

offset
integer
default:0

Pagination offset

Required range: x >= 0
limit
integer
default:50

Results per page

Required range: 1 <= x <= 1000
sort_by
string
default:created_at

Field to sort by

direction
string
default:desc

Sort direction (asc/desc)

Response

Successful Response

Response for list triggers request.

results
TriggerModel · object[]
required

List of triggers

total
integer
required

Total number of triggers

offset
integer
required

Current offset

limit
integer
required

Current limit