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. 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). Allowed Values: EMAIL:, EMAIL:SENT, EMAIL:VIEWED, EMAIL:CLICKED, EMAIL:VIEWEDASWEBPAGE, EMAIL:FORWARDED, EMAIL:SHARED, EMAIL:BOUNCED, EMAIL:COMPLAINED, EMAIL:UNSUBSCRIBED, WEBTRACKING:, WEBTRACKING:PAGEVIEW, LANDINGPAGE:, LANDINGPAGE:CLICK, LANDINGPAGE:CONVERSION, LANDINGPAGE:VIEW, SURVEY:, SURVEY:STARTED, SURVEY:COMPLETED, SMS:*, SMS:SENT, SMS:FAILED, SMS:UNSUBSCRIBED, SMS:INCOMINGMESSAGE
contactID	integer	Return activities for a specific contact
contactFields	string	Comma-separated list of contact fields to return. If not included, contactID will be automatically added. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, mobileNumber, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes Default: contactID, email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Response Data

Name	Type	Description
contact	object	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	object	Details about the email (emailID, title, subject, dateSent). Only included for EMAIL activity types.
webTrackingPage	object	Details about the website tracking page. Only included for WEBTRACKING activity types.
landingPage	object	Details about the landing page. Only included for LANDINGPAGE activity types.
survey	object	Details about the survey. Only included for SURVEY activity types.
sms	object	Details about the SMS. Only included for some SMS activity types.
activityDetails	object	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

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-05-01 00:00:00",
		"endDate": "2017-05-01 23:59:59",
		"activities": ["EMAIL:*"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-05-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":456},"activity":"EMAIL:SENT"},{"date":"2017-05-01 07:08:14","contact":{"email":"jane.doe@example.com","contactID":124},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":456},"activity":"EMAIL:VIEWED"},{"date":"2017-05-01 08:24:16","contact":{"email":"test@example.com","contactID":125},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":456},"activity":"EMAIL:BOUNCED","activityDetails":{"bounceType":"HB"}},{"...":"..."}]},"requestID":"A354D385-7600-4F57-92856A0E4F238889"}

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

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-05-01 00:00:00",
		"endDate": "2017-05-01 23:59:59",
		"activities": ["EMAIL:CLICKED"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-05-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":123},"activity":"EMAIL:CLICKED","activityDetails":{"link":"http://www.example.com"}},{"...":"..."}]},"requestID":"44420AC2-8489-4157-B6BDB56187B981ED"}

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

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-05-01 00:00:00",
		"endDate": "2017-05-01 23:59:59",
		"activities": ["EMAIL:BOUNCED"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-05-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":123},"activity":"EMAIL:BOUNCED","activityDetails":{"bounceType":"SB"}},{"date":"2017-05-01 07:08:14","contact":{"email":"jane.doe@example.com","contactID":456},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":123},"activity":"EMAIL:BOUNCED","activityDetails":{"bounceType":"HB"}},{"...":"..."}]},"requestID":"2C6DF9AE-49A4-46F2-983C077004E5DD59"}

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

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-08-01 00:00:00",
		"endDate": "2017-08-01 23:59:59",
		"activities": ["WEBTRACKING:PAGEVIEW"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"webTrackingPage":{"page":"/","domain":"example.com"},"activity":"WEBTRACKING:PAGEVIEW","activityDetails":{"duration":60}},{"date":"2017-08-01 07:08:14","contact":{"email":"jane.doe@example.com","contactID":456},"webTrackingPage":{"page":"/contact-us","domain":"example.com"},"activity":"WEBTRACKING:PAGEVIEW","activityDetails":{"duration":0}},{"...":"..."}]},"requestID":"A3A3DB14-9B90-4B73-9BDC06E2736F5E89"}

Landing Page Activities

Get all landing page activities that occurred during a specific date range.

POST

/contacts/activities

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-08-01 00:00:00",
		"endDate": "2017-08-01 23:59:59",
		"activities": ["LANDINGPAGE:*"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"landingPage":{"pageID":"12345678-9012-3456-7890-123456789012","title":"Example Landing Page"},"activity":"LANDINGPAGE:VIEW"},{"date":"2017-08-01 05:35:14","contact":{"email":"john.doe@example.com","contactID":123},"landingPage":{"pageID":"12345678-9012-3456-7890-123456789012","title":"Example Landing Page"},"activity":"LANDINGPAGE:CONVERSION"},{"date":"2017-08-01 07:08:14","contact":{"email":"jane.doe@example.com","contactID":456},"landingPage":{"pageID":"12345678-9012-3456-7890-123456789012","title":"Example Landing Page"},"activity":"LANDINGPAGE:CLICK","activityDetails":{"link":"http://www.example.com"}},{"...":"..."}]},"requestID":"13A46E2C-B3A7-4A14-B79DD907F2A7CBAA"}

Survey Activities

Get all survey activities that occurred during a specific date range.

POST

/contacts/activities

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-08-01 00:00:00",
		"endDate": "2017-08-01 23:59:59",
		"activities": ["SURVEY:*"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"survey":{"surveyID":456,"title":"Example Survey"},"activity":"SURVEY:STARTED"},{"date":"2017-08-01 05:35:14","contact":{"email":"john.doe@example.com","contactID":123},"survey":{"surveyID":456,"title":"Example Survey"},"activity":"SURVEY:STARTED"},{"...":"..."}]},"requestID":"34E3FF5D-471A-4654-848D48902769E069"}

SMS Activities

Get all SMS activities that occurred during a specific date range. Note the "message" and "mediaURLs" properties in "activityDetails" for SMS:INCOMINGMESSAGE activities will contain the text content and URLs to retrieve related media.

POST

/contacts/activities

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-08-01 00:00:00",
		"endDate": "2017-08-01 23:59:59",
		"activities": ["SMS:*"]
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"sms":{"smsID":123,"title":"Example SMS"},"activity":"SMS:SENT"},{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"sms":{"smsID":123,"title":"Example SMS"},"activity":"SMS:FAILED"},{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"sms":{"smsID":123,"title":"Example SMS"},"activity":"SMS:UNSUBSCRIBED"},{"date":"2017-08-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123},"activityDetails":{"message":"Hello","mediaURLs":[]},"activity":"SMS:INCOMINGMESSAGE"},{"...":"..."}]},"requestID":"DEC62EEC-AA0D-43E7-B6CAFE238B415294"}

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

curl https://api.emailer.emfluence.com/v1/contacts/activities \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"startDate": "2017-05-01 00:00:00",
		"endDate": "2017-05-01 23:59:59",
		"activities": ["EMAIL:*"],
		"contactFields": "email,contactID,firstName,lastName,customerID,custom1"
	}'

Response Data

{"code":0,"success":1,"data":{"paging":{"rpp":50,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":50},"records":[{"date":"2017-05-01 05:21:00","contact":{"email":"john.doe@example.com","contactID":123,"firstName":"John","lastName":"Doe","customerID":"984145646","custom1":"Some custom data"},"email":{"subject":"Monthly Newsletter","title":"May Monthly Newsletter","dateSent":"2017-05-01 05:21:00","emailID":456},"activity":"EMAIL:SENT"},{"...":"..."}]},"requestID":"74A41F18-F330-4199-9C417FE6650A9E0E"}

API Console

The console uses production data, so BE CAREFUL!

GET

contacts/activities

Param	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). Allowed Values: EMAIL:, EMAIL:SENT, EMAIL:VIEWED, EMAIL:CLICKED, EMAIL:VIEWEDASWEBPAGE, EMAIL:FORWARDED, EMAIL:SHARED, EMAIL:BOUNCED, EMAIL:COMPLAINED, EMAIL:UNSUBSCRIBED, WEBTRACKING:, WEBTRACKING:PAGEVIEW, LANDINGPAGE:, LANDINGPAGE:CLICK, LANDINGPAGE:CONVERSION, LANDINGPAGE:VIEW, SURVEY:, SURVEY:STARTED, SURVEY:COMPLETED, SMS:*, SMS:SENT, SMS:FAILED, SMS:UNSUBSCRIBED, SMS:INCOMINGMESSAGE
contactID	integer	Return activities for a specific contact
contactFields	string	Comma-separated list of contact fields to return. If not included, contactID will be automatically added. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, mobileNumber, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes Default: contactID, email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

Contacts

POST GET contacts/activities

Parameters

Response Data

Example Calls

Email Activities

Email Click Activities

Email Bounce Activities

Website Tracking Page View Activities

Landing Page Activities

Survey Activities

SMS Activities

Specify Contact Fields

API Console