/rules/events

Lists the run history of your rules from the last 15 days, newest first, 50 per page by default. Mixmax records an event each time a rule's trigger fires: success when its actions ran, filtered when the event did not match the rule's filter, pending while it has not finished and error when an action failed. message says what happened. This is the same history the Mixmax app shows under Rules.

Workspace admins can read a teammate's history with userId, or the history of the workspace's shared rules with getWorkspaceEvents=true. Workspace history covers only rules that belong to the workspace, not the personal rules of its members.

Pages use offset, not cursors. hasNext is true whenever the page is full, so the last page can come back empty.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The _id of a teammate whose history to list. Only an admin of that user's workspace can pass another user's id; anyone else gets 403. Defaults to you.

boolean

Pass true to list the history of your workspace's shared rules instead of your own. Only workspace admins can use it; anyone else gets 403.

string

Only events of this rule.

string
enum

Only events with this status.

Allowed:
string

Only events whose recipient email or name starts with this text.

boolean

Pass true to add statuses, a count of the matching events by status, across all pages.

string

A comma-separated list of the fields to return on each event, such as status,date,metadata.ruleId. _id is always returned.

integer
Defaults to 0

How many events to skip. Use the next value of the previous page.

integer
Defaults to 50

How many events to return per page. Defaults to 50.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!