Entity Description:
SentMessage captures the metric information on the message that was sent to recipients
and displays the metrics in the PoliteMail -> Results -> Messages section.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| Subject | String | ||
| SentDate | DateTime | ||
| OwnerID | Int32 | ||
| SendMode | Inr32 | ||
| ChracterCount | Double | ||
| ParagraphCount | Double | ||
| SentenceCount | Double | ||
| SentencesPerParagraph | Double | ||
| WordCount | Double | ||
| WordsPerMinute | Int32 | ||
| WordsPerSentence | Double | ||
| CharactersPerWord | Double | ||
| PassiveSentences | Double | ||
| ReadingEase | Double | ||
| GradeLevel | Double | ||
| Importance | Int32 | ||
| Sensitivity | Double | ||
| ImageCount | Int32 | ||
| ImageArea | Int32 | ||
| ImageAreaPerMinute | Int32 | ||
| SentVia | Boolean | ||
| RecipientCount | Int32 | ||
| IsCampaignMember | Boolean | ||
| AggregateSendCount | Double | ||
| AvgReadTime | Double | ||
| AvgReadTimeDesktop | Double | ||
| AvgReadTimeMobile | Double | ||
| ClickCount | Double | ||
| DesktopClicks | Double | ||
| DesktopOpens | Double | ||
| Devices | Double | ||
| EngagedReads | Double | ||
| EngagementRate | Double | ||
| FirstSentDate | DateTime | ||
| Forwards | Double | ||
| From | String | ||
| Ignored | Double | ||
| Interactions | Double | ||
| LinksClicked | Double | ||
| LinksSent | Double | ||
| Messages | Double | ||
| MobileOpens | Double | ||
| MobileClicks | Double | ||
| MobileUnique | Double | ||
| MostRecentOpenDate | DateTime | ||
| MultipleOpens | Double | ||
| MultipleResponses | Double | ||
| MultipleClicks | Double | ||
| MultipleReads | Double | ||
| NewOpens | Double | ||
| NonUniqueClicks | Double | ||
| NonUniqueOpens | Double | ||
| Oof | Double | ||
| OpenCount | Double | ||
| OptOuts | Double | ||
| OptIns | Double | ||
| ReadCount | Double | ||
| ReadRate | Double | ||
| Recipients | Double | ||
| Replies | Double |
Entity Statement
| Creating a SentMessage | |
| Request | |
| v4.x: POST /ssv3/odata/SentMessages v5.0+: POST /api/odata/SentMessages | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","Subject":"Example Subject", "SentDate":"2014-12-20T11:00:06.155Z","OwnerID":"0","SendMode": "0","CharacterCount":"0","ParagraphCount":"0","SentenceCount":"0", "SentencesPerParagraph":"0","WordCount":"0","WordsPerMinute":"0", "WordsPerSentence":"0","CharactersPerWord":"0","PassiveSentences": "0","ReadingEase":"0","GradeLevel":"0","Importance":"0","Sensitivity": "0","ImageCount":"0","ImageArea":"0","ImageAreaPerMinute":"0", "SentVia":false,"RecipientCount":"0","IsCampaignMember":false, "AggregateSendCount":"0","AvgReadTime":"0","AvgReadTimeMobile": "0","AvgReadTimeDesktop":"0","ClickCount":"0","DesktopClicks":"0", "DesktopOpens":"0","Devices":"0","EngagedReads":"0", "EngagementRate":"0","FirstSentDate":"2014-12-20T11:00:06.155Z", "Forwards":"0","From":"Example Emaill","Ignored":"0","Interactions": "0","LinksClicked":"0","LinksSent":"0","Messages":"0","MobileOpens": "0","MobileClicks":"0","MobileUnique":"0", "MostRecentOpenDate":"2014-12-21T17:48:26.155Z", "MultipleOpens":"0","MultipleResponses":"0","MultipleClicks":"0", "MultipleReads":"0","NewOpens":"0","NonUniqueClicks":"0","NonUniqueOpens": "0","Oof":"0","OpenCount":"0","OptOuts":"0","OptIns":"0","ReadCount": "0","ReadRate":"0","Recipients":"0","Replies":"0" } | |
| Response body | |
| { "ID":1,"Subject":"Example Subject", "SentDate":"2014-12-21T12:00:00.000Z","OwnerID": 0,"SendMode":0,"CharacterCount":0,"ParagraphCount":0,"SentenceCount": 0,"SentencesPerParagraph":0,"WordCount":0,"WordsPerMinute":0, "WordsPerSentence":0,"CharactersPerWord":0,"PassiveSentences":0, "ReadingEase":0,"GradeLevel":0,"Importance":0,"Sensitivity":0, "ImageCount":0,"ImageArea":0,"ImageAreaPerMinute":0, "SentVia":false,"RecipientCount":0,"IsCampaignMember":false, "AggregateSendCount":0,"AvgReadTime":0,"AvgReadTimeMobile": 0,"AvgReadTimeDesktop":0,"ClickCount":0,"DesktopClicks":0, "DesktopOpens":0,"Devices":0,"EngagedReads":0, "EngagementRate":0,"FirstSentDate":"2014-12-21T17:00:06.155Z", "Forwards":0,"From":"Example Emaill","Ignored":0,"Interactions":0, "LinksClicked":0,"LinksSent":0,"Messages":0,"MobileOpens":0, "MobileClicks":0,"MobileUnique":0, "MostRecentOpenDate":"2014-12-21T17:48:26.155Z", "MultipleOpens":0,"MultipleResponses":0,"MultipleClicks":0,"MultipleReads": 0,"NewOpens":0,"NonUniqueClicks":0,"NonUniqueOpens":0,"Oof":0, "OpenCount":0,"OptOuts":0,"OptIns":0,"ReadCount":0,"ReadRate":0, "Recipients":0,"Replies":0 } | |
| Deleting a SentMessage | |
| Request | |
| v4.x: DELETE/ssv3/odata/SentMessages v5.0+: DELETE /api/odata/SentMessages | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a SentMessage | |
| Request | |
| v4.x: GET /ssv3/odata/SentMessages(1) v5.0+: GET /api/odata/SentMessages(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"Subject":"Example Subject","SentDate":"2014-12-21T12:00:00.000Z", "OwnerID":0,"SendMode":0,"CharacterCount":0,"ParagraphCount":0, "SentenceCount":0,"SentencesPerParagraph":0,"WordCount":0, "WordsPerMinute":0,"WordsPerSentence":0,"CharactersPerWord":0, "PassiveSentences":0,"ReadingEase":0,"GradeLevel":0,"Importance":0, "Sensitivity":0,"ImageCount":0,"ImageArea":0,"ImageAreaPerMinute":0, "SentVia":false,"RecipientCount":0,"IsCampaignMember":false, "AggregateSendCount":0,"AvgReadTime":0,"AvgReadTimeMobile":0, "AvgReadTimeDesktop":0,"ClickCount":0,"DesktopClicks":0,"DesktopOpens": 0,"Devices":0,"EngagedReads":0,"EngagementRate":0, "FirstSentDate":"2014-12-21T17:00:06.155Z","Forwards":0,"From": "Example Emaill","Ignored":0,"Interactions":0,"LinksClicked":0,"LinksSent": 0,"Messages":0,"MobileOpens":0,"MobileClicks":0,"MobileUnique": 0,"MostRecentOpenDate":"2014-12-21T17:48:26.155Z","MultipleOpens":0, "MultipleResponses":0,"MultipleClicks":0,"MultipleReads":0,"NewOpens":0, "NonUniqueClicks":0,"NonUniqueOpens":0,"Oof":0,"OpenCount":0, "OptOuts":0,"OptIns":0,"ReadCount":0,"ReadRate":0,"Recipients":0,"Replies":0 } | |
| Updating a SentMessage | |
| Request | |
| PUT /ssv3/odata/SentMessages(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","Subject":"Example Subject","SentDate":"2014-12-20T11:00:06.155Z", "OwnerID":"0","SendMode":"0","CharacterCount":"0","ParagraphCount": "0","SentenceCount":"0","SentencesPerParagraph":"0","WordCount":"0", "WordsPerMinute":"0","WordsPerSentence":"0","CharactersPerWord":"0", "PassiveSentences":"0","ReadingEase":"0","GradeLevel":"0","Importance": "0","Sensitivity":"0","ImageCount":"0","ImageArea":"0","ImageAreaPerMinute": "0","SentVia":false,"RecipientCount":"0","IsCampaignMember":false, "AggregateSendCount":"0","AvgReadTime":"0","AvgReadTimeMobile": "0","AvgReadTimeDesktop":"0","ClickCount":"0","DesktopClicks":"0", "DesktopOpens":"0","Devices":"0","EngagedReads":"0","EngagementRate": "0","FirstSentDate":"2014-12-20T11:00:06.155Z","Forwards":"0","From": "Example Emaill","Ignored":"0","Interactions":"0","LinksClicked":"0", "LinksSent":"0","Messages":"0","MobileOpens":"0","MobileClicks":"0", "MobileUnique":"0","MostRecentOpenDate":"2014-12-21T17:48:26.155Z", "MultipleOpens":"0","MultipleResponses":"0","MultipleClicks":"0", "MultipleReads":"0","NewOpens":"0","NonUniqueClicks":"0","NonUniqueOpens": "0","Oof":"0","OpenCount":"0","OptOuts":"0","OptIns":"0","ReadCount": "0","ReadRate":"0","Recipients":"0","Replies":"0" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all SentMessages | |
| Request | |
| GET /api/odata/SentMessages | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":0,"Subject":"Example Subject","SentDate":"2014-12-20T11:00:06.155Z", "OwnerID":0,"SendMode":0,"CharacterCount":0,"ParagraphCount":0, "SentenceCount":0,"SentencesPerParagraph":0,"WordCount":0, "WordsPerMinute":0,"WordsPerSentence":0,"CharactersPerWord":0, "PassiveSentences":0,"ReadingEase":0,"GradeLevel":0,"Importance":0, "Sensitivity":0,"ImageCount":0,"ImageArea":0,"ImageAreaPerMinute":0, "SentVia":false,"RecipientCount":0,"IsCampaignMember":false, "AggregateSendCount":0,"AvgReadTime":0,"AvgReadTimeMobile":0, "AvgReadTimeDesktop":0,"ClickCount":0,"DesktopClicks":0,"DesktopOpens": 0,"Devices":0,"EngagedReads":"0","EngagementRate":0, "FirstSentDate":"2014-12-20T11:00:06.155Z","Forwards":0,"From": "Example Emaill","Ignored":0,"Interactions":0,"LinksClicked":0,"LinksSent":0, "Messages":0,"MobileOpens":0,"MobileClicks":0,"MobileUnique":0, "MostRecentOpenDate":"2014-12-21T17:48:26.155Z","MultipleOpens":0, "MultipleResponses":0,"MultipleClicks":0,"MultipleReads":0,"NewOpens":0, "NonUniqueClicks":0,"NonUniqueOpens":0,"Oof":0,"OpenCount":0,"OptOuts": 0,"OptIns":0,"ReadCount":0,"ReadRate":0,"Recipients":0,"Replies":0 },{ "ID":1,"Subject":"Example Subject","SentDate":"2014-12-21T12:00:00.000Z", "OwnerID":0,"SendMode":0,"CharacterCount":0,"ParagraphCount":0, "SentenceCount":0,"SentencesPerParagraph":0,"WordCount":0, "WordsPerMinute":0,"WordsPerSentence":0,"CharactersPerWord":0, "PassiveSentences":0,"ReadingEase":0,"GradeLevel":0,"Importance":0, "Sensitivity":0,"ImageCount":0,"ImageArea":0,"ImageAreaPerMinute":0, "SentVia":false,"RecipientCount":0,"IsCampaignMember":false, "AggregateSendCount":0,"AvgReadTime":0,"AvgReadTimeMobile":0, "AvgReadTimeDesktop":0,"ClickCount":0,"DesktopClicks":0,"DesktopOpens":0, "Devices":0,"EngagedReads":0,"EngagementRate":0, "FirstSentDate":"2014-12-21T17:00:06.155Z","Forwards":0,"From": "Example Emaill","Ignored":0,"Interactions":0,"LinksClicked":0,"LinksSent":0, "Messages":0,"MobileOpens":0,"MobileClicks":0,"MobileUnique":0, "MostRecentOpenDate":"2014-12-21T17:48:26.155Z", "MultipleOpens":0,"MultipleResponses":0,"MultipleClicks":0,"MultipleReads":0, "NewOpens":0,"NonUniqueClicks":0,"NonUniqueOpens":0,"Oof":0, "OpenCount":0,"OptOuts":0,"OptIns":0,"ReadCount":0,"ReadRate":0, "Recipients":0,"Replies":0 }] | |
