list_site_email_engagement

Pass period, or from and to for a custom range, to narrow it to a window, and leave all three out for every tracked email. activity decides which tracked emails stay, sort their order, and search keeps the emails whose recipient or clicked link contains the text.

Items carry the same fields as list_site_email_sends, opens and clicks included, and nextCursor pages on with the same arguments. Opens are approximate and count per email, never per recipient, so the tool tells the client never to say that a particular recipient read one. See Track opens and clicks.

Inputs

Input	Type	Required	Description
projectId	string	Yes	The site id.
period	string	No	One of day, 24h, 7d, 30d, 90d, 12mo or all. day is today so far, from midnight UTC, 24h is the current hour and the 23 before it, 7d, 30d and 90d are the last 7, 30 and 90 days counting today, 12mo is this month and the 11 before it, and all reaches back to the first record. Leave it out when you send from and to.
from	string	No	The first day of a custom range as YYYY-MM-DD in UTC, sent together with to.
to	string	No	The last day of a custom range as YYYY-MM-DD in UTC, included in the range and sent together with from.
activity	string	No	Which tracked emails to keep: engaged for the ones opened or clicked, opened, clicked, not-opened for the ones delivered and never opened, or tracked for every tracked email. Defaults to engaged.
sort	string	No	The order of the list: newest, oldest, most-opens or most-clicks. Defaults to newest.
search	string	No	Keeps only the emails whose recipient or clicked link contains this text, at most 200 characters.
cursor	string	No	The nextCursor from the previous page, sent with the same arguments. Leave it out for the first page.