Retrieve contact trends for a list

get

https://{youraccountname}.api-us1.com/api/3/ai/report_trends_activity

Daily contact and unsubscribe totals for a date window, the same numbers as the Contact Trends report. Pass list_id for one list. Omit it, or send 0, for every list the caller can access. A caller who is not a main-group admin only receives lists they are allowed to see. unsubscribe_total is the count of memberships still unsubscribed whose unsubscribe date falls in the window. The series is built from the current membership row, so a contact who left and later resubscribed is counted from the latest subscribe date only, and a deleted contact is absent.

Query Params

list_id

integer

≥ 0

Defaults to 0

List id. Omit it, or send 0, for every list the caller can access. The query key is list_id.

from

string

required

First day of the window, as YYYY-MM-DD, counted from 00:00:00. Required, and must be on or before to.

string

required

Last day of the window, as YYYY-MM-DD, counted through 23:59:59. Required, and must be on or after from.

graph

string

enum

Which series to calculate. active_contacts and total_contacts are daily running contact totals. new_contacts is joins per day (subscribe date on one list, contact created date when list_id is omitted). unsubscribes makes unsubscribe_total the count of unsubscribes in the window. Omit it for the Contact Trends default, a daily running total that does not restrict the start count to memberships that are still active.

Allowed:

Responses

200Contact and unsubscribe totals for the window.

422A query parameter was rejected: from or to missing or not YYYY-MM-DD, to before from, list_id negative, or a graph value outside the allowed set.