POST GET contacts/activities

Get all contact activities by date range. When paging through results it is important to use static dates for startDate and endDate to ensure the data is consistent throughout the results. Only data for the last year is available. Data provided by this endpoint may be delayed.

* required

Parameters

Name Type Description
startDate * datetime Return activities after this date. Due to the large amount of data that can be returned, it is recommended to use a narrow date range.
endDate * datetime Return activities before this date. For consistent results, use a static value (i.e. don't use a function to get the current time) in the past and keep the same value when paging through results.
activities * array[string] Activities are categorized by type and can be filtered using the pattern "{activityType}:{activity}". Use * to return all activities of a particular type (e.g. EMAIL:* will return all email-related activities).
EMAIL:*, EMAIL:SENT, EMAIL:VIEWED, EMAIL:CLICKED, EMAIL:VIEWEDASWEBPAGE, EMAIL:FORWARDED, EMAIL:SHARED, EMAIL:BOUNCED, EMAIL:COMPLAINED, EMAIL:UNSUBSCRIBED, WEBTRACKING:*, WEBTRACKING:PAGEVIEW
contactID integer Return activities for a specific contact
contactFields string Comma-separated list of contact fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore
contactID, email
page integer Number of page in results to return
1
1
rpp integer Number of records to return per page
100
1
1000
sortDirection string The direction to sort results
asc
asc, desc

Response Data

Name Type Description
contact struct Contains details about the contact. You can specify which fields to return using the contactFields parameter
activity string The name of the activity
date datetime The date of the activity
email struct Details about the email (emailID, title, subject, dateSent). Only included for EMAIL activity types.
webTrackingPage struct Details about the website tracking page. Only included for WEBTRACKING activity types.
activityDetails struct Extra information about the activity (if applicable). Not all activities will include activityDetails. See examples calls for more information.

Example Calls

Email Activities

Get all email activities that occurred during a specific date range

POST
/contacts/activities
cURL
Copy
Response Data

Email Click Activities

Get all email click activities that occurred during a specific date range. Note the "link" property in "activityDetails" which will contain the URL of the clicked link.

POST
/contacts/activities
cURL
Copy
Response Data

Email Bounce Activities

Get all email bounce activities that occurred during a specific date range. Note the "bounceType" property in "activityDetails" which will contain a short code indicating the type of bounce. "HB" for hard bounces (i.e. bad email address), "SB" for all other (soft) bounces.

POST
/contacts/activities
cURL
Copy
Response Data

Website Tracking Page View Activities

Get all website tracking page view activities that occurred during a specific date range. Note the "duration" property in "activityDetails" which will contain the amount of time spent on the page, represented in seconds.

POST
/contacts/activities
cURL
Copy
Response Data

Specify Contact Fields

Request specific contact fields to be returned. Note that all fields will be returned as top-level keys under the "contact" object.

POST
/contacts/activities
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
GET
contacts/activities
Param Value Type Description
startDate * datetime Return activities after this date. Due to the large amount of data that can be returned, it is recommended to use a narrow date range.
endDate * datetime Return activities before this date. For consistent results, use a static value (i.e. don't use a function to get the current time) in the past and keep the same value when paging through results.
activities * array[string] Activities are categorized by type and can be filtered using the pattern "{activityType}:{activity}". Use * to return all activities of a particular type (e.g. EMAIL:* will return all email-related activities).
EMAIL:*, EMAIL:SENT, EMAIL:VIEWED, EMAIL:CLICKED, EMAIL:VIEWEDASWEBPAGE, EMAIL:FORWARDED, EMAIL:SHARED, EMAIL:BOUNCED, EMAIL:COMPLAINED, EMAIL:UNSUBSCRIBED, WEBTRACKING:*, WEBTRACKING:PAGEVIEW
contactID integer Return activities for a specific contact
contactFields string Comma-separated list of contact fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore
contactID, email
page integer Number of page in results to return
1
1
rpp integer Number of records to return per page
100
1
1000
sortDirection string The direction to sort results
asc
asc, desc
Access token: *