Filter subscribers based on engagement
Authorizations
Authenticate API requests via an API Key
Body
Filter subscribers based on engagement and subscription criteria using the 'all' array with filter conditions that must all be met (AND logic).
Array of filter conditions where ALL must be met (AND logic)
Controls how engagement-filter count thresholds are tallied. raw (default) counts every event — five opens of the same email = five. unique_email counts distinct emails on which the action occurred — five opens of the same email = one. Applies to every engagement filter (opens, clicks, sent, delivered) in the request; ignored for other filter types.
raw, unique_email Optional. Array of { type, ...config } objects naming additional fields to embed on each subscriber row. Valid types: attribution, tags, location, canceled_at, stats. The stats type accepts an optional range: { start, end } (YYYY-MM-DD dates, defaulting to the last 90 days).
[
{ "type": "tags" },
{
"type": "stats",
"range": {
"start": "2026-05-01",
"end": "2026-06-30"
}
},
{ "type": "location" }
]