Skip to main content
GET
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.

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_count and event_count at the top give both totals, and pagination.total equals people_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_state is 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

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character sequence id.

Query Parameters

limit
number

Results per page. Default 25. Above 100 is treated as 100.

Required range: 1 <= x <= 100
page
number
default:1

Page number, 1-based, up to 10,000.

Required range: 1 <= x <= 10000
metric
enum<string>
required

Which 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.

Available options:
delivered,
opened,
clicked,
replied,
bounced,
opted_out,
failed,
scheduled,
contacted

Response

A page of people.

A page of results.

data
object[]
required
pagination
object
required

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.

metric
string

The metric listed.

people_count
integer

Distinct people with at least one matching event. Same as pagination.total.

event_count
integer

Total matching events across those people.