reports

List email activity

Get a list of member's subscriber activity in a specific campaign.

get/3.0/reports/{campaign_id}/email-activity

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

sincestring

Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

filter_botsboolean

When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity).

Response

campaign_idstring

The unique id for the sent campaign.

total_itemsinteger

The total number of items matching the query regardless of pagination.

Changes

No recorded changes to this operation across all 1 revision of this API.