Get List Performance

GET

/lists/performance

• Production
• QA

Engagement counters for one list or every list the key may see.

Authorizations

• BearerAuth

Parameters

Query Parameters

list_id

Any of:

integer

integer

null

null

Filter to a single list. Omit for all lists.

days

Any of:

integer

integer

>= 1

null

null

Restrict sends/events to the last N days. Omit for all-time. Ignored when start_date and end_date are both supplied.

start_date

Any of:

string

string

null

null

Inclusive start of an anchored range, YYYY-MM-DD. Requires end_date.

end_date

Any of:

string

string

null

null

Inclusive end of an anchored range, YYYY-MM-DD.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

items

Array<object>

Per-list engagement counters. Fields mirror the app’s own item.

object

list_id

Any of:

integer

integer

null

null

title

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string