List the people behind an engagement metric
Lists the people behind one engagement counter, one row per person, most recent activity first, 25 per page unless you set limit. metric is required.
Counters count events, so someone who opened three times is one row with event_count: 3. The top-level people_count and event_count give both totals, and pagination.total is people_count. This list reads the event history directly, so it can be ahead of the counters on GET /v2/sequencer/sequences/{id}/analytics, which are rebuilt every 15 minutes.
Each row links to the person’s enrollment in this sequence (sequence_state), the newest one if they were enrolled more than once. Counts toward the Sequencer reads rate limit.
limit.
Example
Who opened, most recent first:Metrics
Things to know
- The counters on Get sequence analytics
count events, so a person who opened three times is one row here with
event_count: 3.people_countandevent_countat the top give both totals, andpagination.totalequalspeople_count. - This list reads the event history directly. The counters are rebuilt every 15 minutes, so for a short while the list can be ahead of the number on the counter.
sequence_stateis the person’s enrollment in this sequence, the newest one if they were enrolled more than once. Open its timeline with List enrollment events.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
24-character sequence id.
Query Parameters
Results per page. Default 25. Above 100 is treated as 100.
1 <= x <= 100Page number, 1-based, up to 10,000.
1 <= x <= 10000Which counter to list the people behind. delivered, opened, clicked, replied, bounced, opted_out and failed each match one kind of event. scheduled is emails sent plus tasks created. contacted is emails sent or delivered, plus calls and tasks completed.
delivered, opened, clicked, replied, bounced, opted_out, failed, scheduled, contacted Response
A page of people.
A page of results.
Pagination for the paged lists under /v2/sequencer. Every paged list uses this one shape; a few short lists (a sequence's steps, the team's policies, a task's events and enrollment runs) return a plain array instead.
The metric listed.
Distinct people with at least one matching event. Same as pagination.total.
Total matching events across those people.