Connectors Reference
Measure results with powerful email metrics, including opens, read-time and click through rates plus valuable analytics to help you gain the insights you need to improve your communications.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Get businesses |
|
|
Get regions |
|
|
Get campaigns |
|
|
Get contacts from a list |
|
|
Contacts_NewContact (Contacts_NewContactParameterParameters parameters) |
Create a contact |
|
Images_NewImage (Images_NewImageParameterParameters parameters) |
Upload an image |
|
Get importance |
|
|
Get sensitivities |
|
|
Get lists |
|
|
Lists_AddEmailsById (integer id, [Optional]Lists_AddEmailsByIdParameterParameters parameters) |
Add emails to a list |
|
Lists_RemoveEmailsById (integer id, [Optional]Lists_RemoveEmailsByIdParameterParameters parameters) |
Remove emails from list |
|
Create a list |
|
|
Templates_NewTemplate (Templates_NewTemplateParameterParameters parameters) |
Create a template |
|
SentMessages_Send (SentMessages_SendParameterParameters parameters) |
Send a message |
|
SmartAttachments_NewAttachment (SmartAttachments_NewAttachmentParameterParameters parameters) |
Upload a SmartAttachment |
|
Campaigns_NewCampaign (Campaigns_NewCampaignParameterParameters parameters) |
Create a campaign |
|
Get owners |
|
Name |
Summary |
|
When there is a new contact |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get businesses
Description: This action returns all businesses.
Syntax:
PoliteMail.Businesses_GetBusinesses ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:Businesses_GetBusinessesResponse
Summary: Get regions
Description: This action returns all regions.
Syntax:
PoliteMail.Regions_GetRegions ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:Regions_GetRegionsResponse
Summary: Get campaigns
Description: This action returns all campaigns.
Syntax:
PoliteMail.Campaigns_GetCampaigns ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:Campaigns_GetCampaignsResponse
Summary: Get contacts from a list
Description: This action will retrieve all contacts from a list.
Syntax:
PoliteMail.Contacts_GetContactsFromList (integer id, [advanced][Optional]string $expand, [advanced][Optional]string $select)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer(int32) (Select List) |
key: id |
True |
|
|
$expand |
string (Expand) |
Expands related entities inline. |
False |
|
|
$select |
string (Select) |
Selects which properties to include in the response. |
False |
Returns:
Type:Contacts_GetContactsFromListResponse
Summary: Create a contact
Description: This action will create a contact.
Syntax:
PoliteMail.Contacts_NewContact (Contacts_NewContactParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
Contacts_NewContactParameterParameters
|
|
True |
Returns:
Type:Contacts_NewContactResponse
Summary: Upload an image
Description: This action will upload an image to the PoliteMail server.
Syntax:
PoliteMail.Images_NewImage (Images_NewImageParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
Images_NewImageParameterParameters
|
|
True |
Returns:
Summary: Get importance
Description: This action returns all importances.
Syntax:
PoliteMail.Importances_GetImportances ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:Importances_GetImportancesResponse
Summary: Get sensitivities
Description: This action returns all sensitivities.
Syntax:
PoliteMail.Sensitivities_GetSensitivities ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:Sensitivities_GetSensitivitiesResponse
Summary: Get lists
Description: This action returns all lists.
Syntax:
PoliteMail.Lists_GetLists ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Summary: Add emails to a list
Description: This action allows you to add contacts to a PoliteMail list by email address.
Syntax:
PoliteMail.Lists_AddEmailsById (integer id, [Optional]Lists_AddEmailsByIdParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer(int32) (Select List) |
key: id |
True |
|
|
parameters |
Lists_AddEmailsByIdParameterParameters
|
|
False |
Returns:
Type:Lists_AddEmailsByIdResponse
Summary: Remove emails from list
Description: This action allows you to remove contacts from a PoliteMail list by email address.
Syntax:
PoliteMail.Lists_RemoveEmailsById (integer id, [Optional]Lists_RemoveEmailsByIdParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer(int32) (Select List) |
key: id |
True |
|
|
parameters |
Lists_RemoveEmailsByIdParameterParameters
|
|
False |
Returns:
Type:Lists_RemoveEmailsByIdResponse
Summary: Create a list
Description: This action allows you to create a list.
Syntax:
PoliteMail.Lists_NewList (Lists_NewListParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
Lists_NewListParameterParameters
|
|
True |
Returns:
Summary: Create a template
Description: This action allows you to create a template.
Syntax:
PoliteMail.Templates_NewTemplate (Templates_NewTemplateParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
Templates_NewTemplateParameterParameters
|
|
True |
Returns:
Type:Templates_NewTemplateResponse
Summary: Send a message
Description: This allows you to send a tracked message using PoliteMail.
Syntax:
PoliteMail.SentMessages_Send (SentMessages_SendParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
SentMessages_SendParameterParameters
|
|
True |
Returns:
Type:SentMessages_SendResponse
Summary: Upload a SmartAttachment
Description: This action allows you to upload a file as a Smart Attachment.
Syntax:
PoliteMail.SmartAttachments_NewAttachment (SmartAttachments_NewAttachmentParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
SmartAttachments_NewAttachmentParameterParameters
|
|
True |
Returns:
Type:SmartAttachments_NewAttachmentResponse
Summary: Create a campaign
Description: This action will create a Campaign.
Syntax:
PoliteMail.Campaigns_NewCampaign (Campaigns_NewCampaignParameterParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
Campaigns_NewCampaignParameterParameters
|
|
True |
Returns:
Type:Campaigns_NewCampaignResponse
Summary: Get owners
Description: This action returns all owners.
Syntax:
PoliteMail.UserProfiles_GetUserProfiles ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string
|
Expands related entities inline. |
False |
|
|
$filter |
string
|
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string
|
Selects which properties to include in the response. |
False |
|
|
$orderby |
string
|
Sorts the results. |
False |
|
|
$top |
integer(int32)
|
Returns only the first n results. |
False |
|
|
$skip |
integer(int32)
|
Skips the first n results. |
False |
|
|
$count |
boolean
|
Includes a count of the matching results in the response. |
False |
Returns:
Type:UserProfiles_GetUserProfilesResponse
Summary: When there is a new contact
Description: Triggers when a new contact is created
Syntax:
PoliteMail.OnNewContact ()
Returns:
Type:OnNewContactResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
description |
string
|
|
|
ownerID |
integer(int32)
|
|
|
shared |
boolean
|
|
|
creationDate |
string(date-time)
|
|
|
activeState |
boolean
|
|
|
businessID |
integer(int32)
|
|
|
regionID |
integer(int32)
|
|
|
sendMode |
number(double)
|
|
|
characterCount |
number(double)
|
|
|
paragraphCount |
number(double)
|
|
|
sentenceCount |
number(double)
|
|
|
sentencesPerParagraph |
number(double)
|
|
|
wordCount |
number(double)
|
|
|
wordsPerSentence |
number(double)
|
|
|
charactersPerWord |
number(double)
|
|
|
passiveSentences |
number(double)
|
|
|
readingEase |
number(double)
|
|
|
gradeLevel |
number(double)
|
|
|
importance |
number(double)
|
|
|
sensitivity |
number(double)
|
|
|
imageCount |
number(double)
|
|
|
imageArea |
number(double)
|
|
|
sentVia |
boolean
|
|
|
aggregateSendCount |
number(double)
|
|
|
avgReadTime |
number(double)
|
|
|
avgReadTimeDesktop |
number(double)
|
|
|
avgReadTimeMobile |
number(double)
|
|
|
clickCount |
number(double)
|
|
|
desktopClicks |
number(double)
|
|
|
desktopOpens |
number(double)
|
|
|
devices |
number(double)
|
|
|
engagedReads |
number(double)
|
|
|
firstSentDate |
string(date-time)
|
|
|
forwards |
number(double)
|
|
|
from |
string
|
|
|
ignored |
number(double)
|
|
|
interactions |
number(double)
|
|
|
linksClicked |
number(double)
|
|
|
linksSent |
number(double)
|
|
|
messages |
number(double)
|
|
|
mobileOpens |
number(double)
|
|
|
mobileClicks |
number(double)
|
|
|
mobileUnique |
number(double)
|
|
|
mostRecentOpenDate |
string(date-time)
|
|
|
multipleOpens |
number(double)
|
|
|
multipleResponses |
number(double)
|
|
|
multipleClicks |
number(double)
|
|
|
multipleReads |
number(double)
|
|
|
newOpens |
number(double)
|
|
|
nonUniqueClicks |
number(double)
|
|
|
nonUniqueOpens |
number(double)
|
|
|
oof |
number(double)
|
|
|
openCount |
number(double)
|
|
|
optOuts |
number(double)
|
|
|
optIns |
number(double)
|
|
|
readCount |
number(double)
|
|
|
readRate |
number(double)
|
|
|
recipients |
number(double)
|
|
|
replies |
number(double)
|
|
|
sent |
number(double)
|
|
|
skimmed |
number(double)
|
|
|
timeToRead |
number(double)
|
|
|
to |
string
|
|
|
totalInteractions |
number(double)
|
|
|
totalLinksSent |
number(double)
|
|
|
totalLinksClicked |
number(double)
|
|
|
undeliverables |
number(double)
|
|
|
uniqueUrls |
number(double)
|
|
|
uniqueUrlsClicked |
number(double)
|
|
|
user |
string
|
|
|
useDevicesForRates |
boolean
|
|
|
reportRunDate |
string(date-time)
|
|
|
openRate |
number(double)
|
|
|
readsRate |
number(double)
|
|
|
clickRate |
number(double)
|
|
|
attentionRate |
number(double)
|
|
|
effectiveRate |
number(double)
|
|
|
engagementRate |
number(double)
|
|
|
undeliverableRate |
number(double)
|
|
|
oofRate |
number(double)
|
|
|
optOutRate |
number(double)
|
|
|
multipleOpenRate |
number(double)
|
|
|
multipleReadRate |
number(double)
|
|
|
contentUtilization |
number(double)
|
|
|
engagedReadRate |
number(double)
|
|
|
didntOpenRate |
number(double)
|
|
|
ignoredRate |
number(double)
|
|
|
didntClickRate |
number(double)
|
|
|
skimmedRate |
number(double)
|
|
|
forwardRate |
number(double)
|
|
|
replyRate |
number(double)
|
|
|
desktopDeviceSummary |
array of (DeviceCount)
|
|
|
mobileDeviceSummary |
array of (DeviceCount)
|
|
|
reports |
array of (Report)
|
|
|
locations |
array of (Location)
|
|
|
events |
array of (Event)
|
|
|
hourOfDayReads |
array of (HourOfDayRead)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (Campaign)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
Description |
string
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
displayName |
string
|
|
|
firstName |
string
|
|
|
lastName |
string
|
|
|
|
string
|
|
|
activeState |
boolean
|
|
|
creationDate |
string(date-time)
|
|
|
shared |
boolean
|
|
|
ownerID |
integer(int32)
|
|
|
categoryID |
integer(int32)
|
|
|
stageID |
integer(int32)
|
|
|
company |
string
|
|
|
webAddress |
string
|
|
|
title |
string
|
|
|
fileAs |
string
|
|
|
source |
integer(int32)
|
|
|
notes |
string
|
|
|
custom1 |
string
|
|
|
custom2 |
string
|
|
|
custom3 |
string
|
|
|
custom4 |
string
|
|
|
custom5 |
string
|
|
|
custom6 |
string
|
|
|
custom7 |
string
|
|
|
custom8 |
string
|
|
|
custom9 |
string
|
|
|
custom10 |
string
|
|
|
custom11 |
string
|
|
|
custom12 |
string
|
|
|
custom13 |
string
|
|
|
custom14 |
string
|
|
|
custom15 |
string
|
|
|
custom16 |
string
|
|
|
custom17 |
string
|
|
|
custom18 |
string
|
|
|
custom19 |
string
|
|
|
custom20 |
string
|
|
|
businessID |
integer(int32)
|
|
|
regionID |
integer(int32)
|
|
|
lastChangedDate |
string(date-time)
|
|
|
listID |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (Contact)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
FirstName |
string
|
|
|
LastName |
string
|
|
|
|
string
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
count |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
openCount |
integer(int32)
|
|
|
clickCount |
integer(int32)
|
|
|
eventDate |
string(date-time)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
hour |
string(date-time)
|
|
|
timeRead |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
ContentType |
string Content Type |
|
|
Data |
string(byte)
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
Privacy |
integer(int32)
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (Importance)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
description |
string
|
|
|
ownerID |
integer(int32)
|
|
|
memberCount |
integer(int32)
|
|
|
isNewsletter |
integer(int32)
|
|
|
shared |
boolean
|
|
|
creationDate |
string(date-time)
|
|
|
activeState |
integer(int32)
|
|
|
isAnonymous |
boolean
|
|
|
guid |
string
|
|
|
businessID |
integer(int32)
|
|
|
regionID |
integer(int32)
|
|
|
sendMode |
number(double)
|
|
|
characterCount |
number(double)
|
|
|
paragraphCount |
number(double)
|
|
|
sentenceCount |
number(double)
|
|
|
sentencesPerParagraph |
number(double)
|
|
|
wordCount |
number(double)
|
|
|
wordsPerSentence |
number(double)
|
|
|
charactersPerWord |
number(double)
|
|
|
passiveSentences |
number(double)
|
|
|
readingEase |
number(double)
|
|
|
gradeLevel |
number(double)
|
|
|
importance |
number(double)
|
|
|
sensitivity |
number(double)
|
|
|
imageCount |
number(double)
|
|
|
imageArea |
number(double)
|
|
|
sentVia |
boolean
|
|
|
aggregateSendCount |
number(double)
|
|
|
avgReadTime |
number(double)
|
|
|
avgReadTimeDesktop |
number(double)
|
|
|
avgReadTimeMobile |
number(double)
|
|
|
clickCount |
number(double)
|
|
|
desktopClicks |
number(double)
|
|
|
desktopOpens |
number(double)
|
|
|
devices |
number(double)
|
|
|
engagedReads |
number(double)
|
|
|
firstSentDate |
string(date-time)
|
|
|
forwards |
number(double)
|
|
|
from |
string
|
|
|
ignored |
number(double)
|
|
|
interactions |
number(double)
|
|
|
linksClicked |
number(double)
|
|
|
linksSent |
number(double)
|
|
|
messages |
number(double)
|
|
|
mobileOpens |
number(double)
|
|
|
mobileClicks |
number(double)
|
|
|
mobileUnique |
number(double)
|
|
|
mostRecentOpenDate |
string(date-time)
|
|
|
multipleOpens |
number(double)
|
|
|
multipleResponses |
number(double)
|
|
|
multipleClicks |
number(double)
|
|
|
multipleReads |
number(double)
|
|
|
newOpens |
number(double)
|
|
|
nonUniqueClicks |
number(double)
|
|
|
nonUniqueOpens |
number(double)
|
|
|
oof |
number(double)
|
|
|
openCount |
number(double)
|
|
|
optOuts |
number(double)
|
|
|
optIns |
number(double)
|
|
|
readCount |
number(double)
|
|
|
readRate |
number(double)
|
|
|
recipients |
number(double)
|
|
|
replies |
number(double)
|
|
|
sent |
number(double)
|
|
|
skimmed |
number(double)
|
|
|
timeToRead |
number(double)
|
|
|
to |
string
|
|
|
totalInteractions |
number(double)
|
|
|
totalLinksSent |
number(double)
|
|
|
totalLinksClicked |
number(double)
|
|
|
undeliverables |
number(double)
|
|
|
uniqueUrls |
number(double)
|
|
|
uniqueUrlsClicked |
number(double)
|
|
|
user |
string
|
|
|
useDevicesForRates |
boolean
|
|
|
reportRunDate |
string(date-time)
|
|
|
openRate |
number(double)
|
|
|
readsRate |
number(double)
|
|
|
clickRate |
number(double)
|
|
|
attentionRate |
number(double)
|
|
|
effectiveRate |
number(double)
|
|
|
engagementRate |
number(double)
|
|
|
undeliverableRate |
number(double)
|
|
|
oofRate |
number(double)
|
|
|
optOutRate |
number(double)
|
|
|
multipleOpenRate |
number(double)
|
|
|
multipleReadRate |
number(double)
|
|
|
contentUtilization |
number(double)
|
|
|
engagedReadRate |
number(double)
|
|
|
didntOpenRate |
number(double)
|
|
|
ignoredRate |
number(double)
|
|
|
didntClickRate |
number(double)
|
|
|
skimmedRate |
number(double)
|
|
|
forwardRate |
number(double)
|
|
|
replyRate |
number(double)
|
|
|
filterID |
integer(int32)
|
|
|
listCount |
integer(int32)
|
|
|
modifiedBy |
integer(int32)
|
|
|
modifiedDate |
string(date-time)
|
|
|
desktopDeviceSummary |
array of (DeviceCount)
|
|
|
mobileDeviceSummary |
array of (DeviceCount)
|
|
|
contacts |
array of (Contact)
|
|
|
locations |
array of (Location)
|
|
|
events |
array of (Event)
|
|
|
hourOfDayReads |
array of (HourOfDayRead)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
emails |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (List)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
Description |
string
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
emails |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
latLong |
array of (number(decimal))
|
|
|
count |
integer(int32)
|
|
|
event |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (Contact)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
from |
string
|
|
|
to |
string
|
|
|
subject |
string
|
|
|
sentDate |
string(date-time)
|
|
|
sent |
number(double)
|
|
|
recipients |
number(double)
|
|
|
optout |
number(double)
|
|
|
undeliverable |
number(double)
|
|
|
outOfOffice |
number(double)
|
|
|
nonUniqueOpen |
number(double)
|
|
|
confirmedOpen |
number(double)
|
|
|
reply |
number(double)
|
|
|
forward |
number(double)
|
|
|
uniqueClickThrough |
number(double)
|
|
|
uniqueClickThroughMobile |
number(double)
|
|
|
uniqueClickThroughDesktop |
number(double)
|
|
|
interactions |
number(double)
|
|
|
multipleResponses |
number(double)
|
|
|
newOpens |
number(double)
|
|
|
multipleOpens |
number(double)
|
|
|
nonUniqueClickThrough |
number(double)
|
|
|
totalInteractions |
number(double)
|
|
|
mobileUnique |
number(double)
|
|
|
messages |
number(double)
|
|
|
firstSentDate |
string(date-time)
|
|
|
avgReadTime |
number(double)
|
|
|
avgReadTimeMobile |
number(double)
|
|
|
avgReadTimeDesktop |
number(double)
|
|
|
engagementRate |
number(double)
|
|
|
reads |
number(double)
|
|
|
mostRecentOpenDate |
string(date-time)
|
|
|
multipleReads |
number(double)
|
|
|
ignored |
number(double)
|
|
|
skimmed |
number(double)
|
|
|
engagedRead |
number(double)
|
|
|
multipleClicks |
number(double)
|
|
|
mobileOpens |
number(double)
|
|
|
user |
string
|
|
|
totalLinksSent |
number(double)
|
|
|
totalLinksClicked |
number(double)
|
|
|
uniqueURLS |
number(double)
|
|
|
uniqueURLSClicked |
number(double)
|
|
|
linksSent |
number(double)
|
|
|
linksClicked |
number(double)
|
|
|
wordCount |
number(double)
|
|
|
imageCount |
number(double)
|
|
|
imageArea |
number(double)
|
|
|
timeToRead |
number(double)
|
|
|
devices |
number(double)
|
|
|
sendMode |
number(double)
|
|
|
characterCount |
number(double)
|
|
|
paragraphCount |
number(double)
|
|
|
sentenceCount |
number(double)
|
|
|
sentencesPerParagraph |
number(double)
|
|
|
wordsPerSentence |
number(double)
|
|
|
charactersPerWord |
number(double)
|
|
|
passiveSentences |
number(double)
|
|
|
readingEase |
number(double)
|
|
|
gradeLevel |
number(double)
|
|
|
importance |
number(double)
|
|
|
sensitivity |
number(double)
|
|
|
sendViaOutbox |
boolean
|
|
|
desktopOpens |
number(double)
|
|
|
aggregateSendCount |
number(double)
|
|
|
maxTimeToRead |
number(double)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
array of (Sensitivity)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Campaign |
integer(int32) Select Campaign |
Specify the campaign this message is a part of |
|
To |
string
|
Specify email addresses separated by semicolons |
|
Subject |
string
|
Specify the subject of the mail |
|
Body |
string
|
Specify the body of the mail |
|
From |
string From (Send as) |
First Last <first.last@politemail.com> |
|
CC |
string
|
Specify email addresses separated by semicolons |
|
BCC |
string
|
Specify email addresses separated by semicolons |
|
Importance |
integer(int32) Importance |
Specify the message importance |
|
Sensitivity |
string Sensitivity |
Specify the message sensitivity |
|
IsHTML |
boolean Is HTML |
|
|
SendMode |
integer(int32) Send Mode |
Specify Send Mode for this message: 1-individual, 2-Anonymous, 3-Aggregate Modes Values: [, , ] |
|
SendLater |
string(date-time) Send Later |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
ContentType |
string
|
|
|
Data |
string(byte)
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
Privacy |
integer(int32)
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
Subject |
string
|
|
|
Description |
string
|
|
|
BodyBinary |
string(byte) File |
|
|
Body |
string
|
|
|
OwnerID |
integer(int32) Select Owner |
|
|
Shared |
boolean
|
|
|
BusinessID |
integer(int32) Select Business |
|
|
RegionID |
integer(int32) Select Region |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
odata.metadata |
string
|
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |