POST GET exports/emailShares

Get shares data across email campaigns. Date range cannot span more than 90 days.

* required

Parameters

Name Type Description
startDate * datetime Shares after this date
endDate * datetime Shares before this date
fields string Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateShared, channel, contactID, email
id, emailID, dateShared, channel, contactID, email

Response Data

Name Type Description
jobID integer ID of export job. Use to check the status of the job at /exports/jobStatus

Permissions

Method requires the Client Administrator permission

Example Calls

Shares in past 30 days

GET
/exports/emailShares?startDate=2020-08-21&endDate=2020-09-21
cURL
Copy
Response Data

Report Columns

Name Type Description
id string Unique ID of share record
emailID integer ID of email record
parentEmailID integer ID of parent email record
dateShared datetime Date share was logged
channel string Channel email was saved over (i.e. Facebook, Twitter...)
contactID integer ID of contact record
email string Email address of contact record

Sample Report

"id"	"emailID"	"dateShared"	"channel"	"contactID"	"email"
"123456_26030519"	"123456"	"2013-02-10 05:05:00.0"	"Facebook"	"26030519"	"john.doe@example.com"
"123456_26030520"	"123456"	"2013-02-10 05:06:00.0"	"Twitter"	"26030520"	"jane.doe@example.com"

API Console

The console uses production data, so BE CAREFUL!
GET
exports/emailShares
Param Value Type Description
startDate * datetime Shares after this date
endDate * datetime Shares before this date
fields string Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateShared, channel, contactID, email
id, emailID, dateShared, channel, contactID, email
Access token: *