Entity Description:
All PoliteMail that is distributed is tracked and a record of interactions (e.g. Open and Click counts) with the recipients and the Email is stored and the metadata parsed to capture the metrics for future analysis.
Properties
| Name | Description | Type | Additional Information |
| ID | String | ||
| OpenCount | Int32 | ||
| ClickCount | Int32 | ||
| EventDate | DateTime |
Entity Statement
if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.
| Creating an Event | |
| Request | |
| POST /api/odata/Events | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","OpenCount":"0","ClickCount":"0","EventDate":"2014-11-20T12:00:00.000Z" } | |
| Response body | |
| { "ID":"1","OpenCount":0,"ClickCount":0,"EventDate":"2014-11-20T18:03:00.125Z" } | |
| Deleting an Event | |
| Request | |
| DELETE /api/odata/Event(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting an Event | |
| Request | |
| GET /api/odata/Events(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":"1","OpenCount":0,"ClickCount":0,"EventDate":"2014-11-20T18:03:00.125Z" } | |
| Updating an Event | |
| Request | |
| PUT /api/odata/Events(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","OpenCount":"0","ClickCount":"0","EventDate":"2014-11-20T12:00:00.000Z" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Events | |
| Request | |
| GET /api/odata/Events | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":"0","OpenCount":0,"ClickCount":0,"EventDate":"2014-11-20T12:00:00.000Z" },{ "ID":"1","OpenCount":0,"ClickCount":0,"EventDate":"2014-11-20T18:03:00.125Z" }] | |
