SubscriberActivities
Search SubscriberActivities
Search and list SubscriberActivity records with filtering, sorting, and pagination.
GET
Search SubscriberActivities
A SubscriberActivity records an interaction event for a newsletter subscriber, such as opening an email, clicking a link, or visiting a page.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the SubscriberActivity-List role.Enums
eActiviyType — ActiviyType values
eActiviyType — ActiviyType values
| Value | Name |
|---|---|
| 1 | Open |
| 2 | Click |
| 3 | Visit |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the news letter subscriber linked to this record.
Filter by iD of the news letter linked to this record.
Filter by the activiy type value for this subscriber activity.
Filter by the data value for this subscriber activity.
Filter by date/time value for created on local.
Range Filters
Filter by date/time value for created on local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for created on local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Data
Range filters
Response
200
The list of SubscriberActivity records matching the query. See the Get one SubscriberActivity endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search SubscriberActivities