Entity Description:
The Report entity compiles and displays aggregate information from a tracked email in the metrics section of PoliteMail. Compiled metrics such as unique mobile click-through rates, Unique URLS, multiple opens, time-to-read, etc…
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| From | String | ||
| To | String | ||
| Subject | String | ||
| SentDate | DateTime | ||
| Sent | Double | ||
| Recipients | Double | ||
| Optout | Double | ||
| Undeliverable | Double | ||
| OutOfOffice | Double | ||
| NonUniqueopen | Double | ||
| ConfirmedOpen | Double | ||
| Reply | Double | ||
| Forward | Double | ||
| UniqueClickThrough | Double | ||
| UniqueClickThroughMobile | Double | ||
| UniqueClickThroughDesktop | Double | ||
| Interactions | Double | ||
| MultipleResponses | Double | ||
| NewOpens | Double | ||
| MultipleOpens | Double | ||
| NonUniqueClickThrough | Double | ||
| TotalInteractions | Double | ||
| MobileUnique | Double | ||
| Messages | Double | ||
| FirstSentDate | DateTime | ||
| AvgReadTime | Double | ||
| AvgReadTimeMobile | Double | ||
| AvgReadTimeDesktop | Double | ||
| EngagementRate | Double | ||
| Reads | Double | ||
| MostRecentOpenDate | DateTime | ||
| MultipleReads | Double | ||
| Ignored | Double | ||
| Skimmed | Double | ||
| EngagedRead | Double | ||
| MultipleClicks | Double | ||
| MobileOpens | Double | ||
| User | String | ||
| TotalLinksSent | Double | ||
| TotalLinksClicked | Double | ||
| UniqueURLS | Double | ||
| UniqueURLSClicked | Double | ||
| LinksSent | Double | ||
| LinksClicked | Double | ||
| WordCount | Double | ||
| ImageCount | Double | ||
| ImageArea | Double | ||
| TimeToRead | Double | ||
| Devices | Double | ||
| SendMode | Double | ||
| CharacterCount | Double | ||
| ParagraphCount | Double | ||
| SentenceCount | Double | ||
| SentencesPerParagraph | Double | ||
| WordsPerSentence | Double | ||
| CharactersPerWord | Double | ||
| PassiveSentences | Double | ||
| ReadingEase | Double | ||
| GradeLevel | Double | ||
| Importance | Double | ||
| Sensitivity | Double | ||
| SendViaOutbox | Boolean | ||
| DesktopOpens | Double | ||
| AggregateSendCount | Double | ||
| MaxTimeToRead | Double |
Entity Statement
| Creating a Report | |
| Request | |
| POST /ssv3/odata/Reports | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","From":"Example Email","To":"Example Email","Subject": "Example Subject","SentDate":"2014-12-19T17:48:26.155Z", "Sent":"0","Recipients":"0","OptOut":"0", "Undelivirable":"0","OutOfOffice":"0","NonUniqueOpen":"0", "ConfirmedOpen":"0","Reply":"0","Forward":"0","UniqueClickThrough": "0","UniqueClickThroughMobile":"0" ,"UniqueClickThroughDesktop":"0","Interactions":"0","MultipleResponses":"0", "NewOpens":"0","MultipleOpens":"0","NonUniqueClickThrough": "0","TotalInteractions":"0","MobileUnique":"0","Messages":"0", "FirstSentDate":"2014-12-19T17:48:26.155Z", "AvgReadTime":"0","AvgReadTimeMobile":"0","AvgReadTimeDesktop":"0", "EngagementRate":"0","Reads":"0","MostRecentOpenDate": "2014-12-20T11:38:16.155Z","MultipleReads":"0","Ignored": "0","Skimmed":"0","EngagedRead":"0", "MultipleClicks":"0","MobileOpens":"0","User":"Example User", "TotalLinksSent":"0","TotalLinksClicked":"0","UniqueURLS":"0", "UniqueURLSClicked":"0","LinksSent":"0","LinksClicked":"0","WordCount": "0","ImageCount":"0","ImageArea":"0","TimeToRead":"0", "Devices":"0","SendMode":"0","CharacterCount": "0","ParagraphCount":"0","SentenceCount":"0","SentencesPerParagraph":"0", "WordsPerSentence":"0","CharactersPerWord":"0","PassiveSentences":"0", "ReadingEase":"0","GradeLevel":"0","Importance":"0","Sensitivity": "0","SentViaOutbox":"0","DesktopOpens":"0","AggregateSendCount": "0","MaxTimeToRead":"0" } |
|
| Response body | |
| { "ID":1,"From":"Example Email","To":"Example Email","Subject": "Example Subject","SentDate":"2014-12-19T20:18:20.155Z", "Sent":0,"Recipients":0,"OptOut":0, "Undelivirable":0,"OutOfOffice":0,"NonUniqueOpen":0,"ConfirmedOpen":0, "Reply":0,"Forward":0,"UniqueClickThrough":0,"UniqueClickThroughMobile": 0,"UniqueClickThroughDesktop":0,"Interactions":0,"MultipleResponses": 0,"NewOpens":0,"MultipleOpens":0,"NonUniqueClickThrough":0, "TotalInteractions":0,"MobileUnique": 0,"Messages":0,"FirstSentDate":"2014-12-19T20:18:20.155Z", "AvgReadTime":0,"AvgReadTimeMobile":0,"AvgReadTimeDesktop":0, "EngagementRate":0,"Reads":0, "MostRecentOpenDate":"2014-12-20T11:43:16.155Z","MultipleReads":0, "Ignored":0,"Skimmed":0,"EngagedRead":0,"MultipleClicks":0, "MobileOpens":0,"User": "Example User","TotalLinksSent":0,"TotalLinksClicked":0, "UniqueURLS":0,"UniqueURLSClicked":0,"LinksSent":0,"LinksClicked":0, "WordCount":0,"ImageCount":0,"ImageArea":0, "TimeToRead":0,"Devices":0,"SendMode":0,"CharacterCount":0, "ParagraphCount":0,"SentenceCount":0,"SentencesPerParagraph":0 ,"WordsPerSentence":0,"CharactersPerWord": 0,"PassiveSentences":0,"ReadingEase":0,"GradeLevel":0,"Importance":0, "Sensitivity":0,"SentViaOutbox":0,"DesktopOpens":0,"AggregateSendCount":0, "MaxTimeToRead":0 } |
|
| Deleting a Report | |
| Request | |
| DELETE /ssv3/odata/Reports(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a Report | |
| Request | |
| GET /ssv3/odata/Reports(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"From":"Example Email","To":"Example Email","Subject": "Example Subject","SentDate": "2014-12-19T20:18:20.155Z","Sent":0,"Recipients":0,"OptOut":0, "Undelivirable":0,"OutOfOffice":0,"NonUniqueOpen":0,"ConfirmedOpen":0, "Reply":0,"Forward":0,"UniqueClickThrough":0,"UniqueClickThroughMobile":0, "UniqueClickThroughDesktop":0,"Interactions":0,"MultipleResponses":0, "NewOpens":0,"MultipleOpens":0,"NonUniqueClickThrough": 0,"TotalInteractions":0,"MobileUnique":0,"Messages":0, "FirstSentDate":"2014-12-19T20:18:20.155Z", "AvgReadTime":0,"AvgReadTimeMobile":0,"AvgReadTimeDesktop":0, "EngagementRate":0,"Reads":0,"MostRecentOpenDate": "2014-12-20T11:43:16.155Z","MultipleReads":0,"Ignored": 0,"Skimmed":0,"EngagedRead":0,"MultipleClicks":0,"MobileOpens":0, "User":"Example User","TotalLinksSent":0,"TotalLinksClicked":0, "UniqueURLS":0,"UniqueURLSClicked": 0,"LinksSent":0,"LinksClicked":0,"WordCount":0,"ImageCount":0,"ImageArea":0, "TimeToRead":0,"Devices":0,"SendMode":0,"CharacterCount":0, "ParagraphCount":0,"SentenceCount":0,"SentencesPerParagraph":0, "WordsPerSentence":0,"CharactersPerWord": 0,"PassiveSentences":0,"ReadingEase":0,"GradeLevel":0, "Importance":0,"Sensitivity":0,"SentViaOutbox":0,"DesktopOpens":0, "AggregateSendCount":0,"MaxTimeToRead":0 } |
|
| Updating a Report | |
| Request | |
| PUT /ssv3/odata/Reports(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","From":"Example Email","To":"Example Email","Subject": "Example Subject","SentDate":"2014-12-19T17:48:26.155Z","Sent": "0","Recipients":"0","OptOut":"0", "Undelivirable":"0","OutOfOffice":"0","NonUniqueOpen": "0","ConfirmedOpen":"0","Reply":"0","Forward":"0","UniqueClickThrough": "0","UniqueClickThroughMobile":"0", "UniqueClickThroughDesktop":"0","Interactions":"0", "MultipleResponses":"0","NewOpens": "0","MultipleOpens":"0","NonUniqueClickThrough":"0","TotalInteractions": "0","MobileUnique":"0","Messages":"0","FirstSentDate": "2014-12-19T17:48:26.155Z","AvgReadTime":"0","AvgReadTimeMobile":"0", "AvgReadTimeDesktop":"0","EngagementRate": "0","Reads":"0","MostRecentOpenDate":"2014-12-20T11:38:16.155Z", "MultipleReads":"0","Ignored":"0","Skimmed":"0","EngagedRead": "0","MultipleClicks":"0","MobileOpens":"0","User": "Example User","TotalLinksSent":"0","TotalLinksClicked":"0", "UniqueURLS":"0","UniqueURLSClicked":"0","LinksSent":"0","LinksClicked": "0","WordCount":"0","ImageCount":"0","ImageArea":"0", "TimeToRead":"0","Devices":"0","SendMode":"0","CharacterCount": "0","ParagraphCount":"0","SentenceCount":"0","SentencesPerParagraph": "0","WordsPerSentence":"0","CharactersPerWord":"0","PassiveSentences": "0","ReadingEase":"0","GradeLevel":"0","Importance":"0","Sensitivity": "0","SentViaOutbox":"0","DesktopOpens":"0", "AggregateSendCount":"0","MaxTimeToRead":"0" } |
|
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Reports | |
| Request | |
| GET /ssv3/odata/Reports | |
| Content-Type | |
| application/json | |
| Response body | |
|
"value":[{ "ID":0,"From":"Example Email","To":"Example Email","Subject": "Example Subject","SentDate":"2014-12-19T17:48:26.155Z", "Sent":0,"Recipients":0,"OptOut":0,"Undelivirable": 0,"OutOfOffice":0,"NonUniqueOpen":0,"ConfirmedOpen":0,"Reply": 0,"Forward":0,"UniqueClickThrough":0,"UniqueClickThroughMobile": 0,"UniqueClickThroughDesktop":0,"Interactions":0,"MultipleResponses": 0,"NewOpens":0,"MultipleOpens":0,"NonUniqueClickThrough": 0,"TotalInteractions":0,"MobileUnique":0,"Messages": 0,"FirstSentDate":"2014-12-19T17:48:26.155Z","AvgReadTime":0, "AvgReadTimeMobile":0,"AvgReadTimeDesktop":0,"EngagementRate":0,"Reads": 0,"MostRecentOpenDate":"2014-12-20T11:38:16.155Z","MultipleReads": 0,"Ignored":0,"Skimmed":0,"EngagedRead":0,"MultipleClicks": 0,"MobileOpens":0,"User":"Example User","TotalLinksSent":0,"TotalLinksClicked": 0,"UniqueURLS":0,"UniqueURLSClicked":0,"LinksSent":0,"LinksClicked": 0,"WordCount":0,"ImageCount":0,"ImageArea": 0,"TimeToRead":0,"Devices":0,"SendMode":0,"CharacterCount":0, "ParagraphCount":0,"SentenceCount":0,"SentencesPerParagraph": 0,"WordsPerSentence":0,"CharactersPerWord": 0,"PassiveSentences":0,"ReadingEase":0,"GradeLevel":0,"Importance":0,"Sensitivity": 0,"SentViaOutbox":0,"DesktopOpens":0,"AggregateSendCount":0,"MaxTimeToRead":0 },{ "ID":1,"From":"Example Email","To":"Example Email","Subject":"Example Subject", "SentDate":"2014-12-19T20:18:20.155Z","Sent":0,"Recipients":0,"OptOut":0, "Undelivirable":0,"OutOfOffice":0,"NonUniqueOpen":0,"ConfirmedOpen": 0,"Reply":0,"Forward":0,"UniqueClickThrough": 0,"UniqueClickThroughMobile":0,"UniqueClickThroughDesktop":0,"Interactions": 0,"MultipleResponses":0,"NewOpens":0,"MultipleOpens":0,"NonUniqueClickThrough": 0,"TotalInteractions":0,"MobileUnique":0,"Messages":0,"FirstSentDate":"2014-12-19T20:18:20.155Z", "AvgReadTime":0,"AvgReadTimeMobile":0,"AvgReadTimeDesktop":0, "EngagementRate":0,"Reads":0,"MostRecentOpenDate":"2014-12-20T11:43:16.155Z", "MultipleReads":0,"Ignored": 0,"Skimmed":0,"EngagedRead":0,"MultipleClicks":0,"MobileOpens":0,"User": "Example User","TotalLinksSent":0,"TotalLinksClicked":0,"UniqueURLS":0, "UniqueURLSClicked":0,"LinksSent":0,"LinksClicked":0,"WordCount": 0,"ImageCount":0,"ImageArea":0,"TimeToRead": 0,"Devices":0,"SendMode":0,"CharacterCount":0,"ParagraphCount": 0,"SentenceCount":0,"SentencesPerParagraph":0,"WordsPerSentence": 0,"CharactersPerWord":0,"PassiveSentences": 0,"ReadingEase":0,"GradeLevel":0,"Importance":0,"Sensitivity":0,"SentViaOutbox": 0,"DesktopOpens":0,"AggregateSendCount":0,"MaxTimeToRead":0 }] |
|
