Entity Description:
The Click is tracked in PoliteMail with the Click-Thru Rate (CTR) metric which is the total number of unique individual recipients who have clicked (at least one link), to the total recipients the email was delivered to. (e.g. how many emails were distributed compared to the number of recipients that opened the email). With PoliteMail’s Click tracking, each recipient’s email address is only counted once, no matter how many times they have clicked.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| LinkID | Int32 | ||
| RefID | Int32 | ||
| OwnerID | Int32 | ||
| DeviceID | Int32 | ||
| IPAddress | String | ||
| UserAgent | String | ||
| Browser | String | ||
| Version | String | ||
| IsMobile | Boolean | ||
| MobileDeviceManufacturer | String | ||
| MobileDeviceModel | String | ||
| Latitude | Decimal | ||
| Longitude | Decimal | ||
| BrowserLanguage | String | ||
| FullUserAgent | String | ||
| Referrer | String | ||
| ClickDate | DateTime | ||
| ActionUrl | String | ||
| ActionName | String | ||
| String |
Entity Statement
if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.
| Creating a Click | |
| Request | |
| POST /api/odata/Clicks | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","LinkID":"0","RefID":"0","OwnerID":"0","DeviceID":"0", "IPAddress":"0.0.0.0","UserAgent":"Example User Agent", "Browser":"Example Browser","Version": "Example Version","IsMobile":true,"MobileDeviceManufacturer": "Example Manufacturer","MobileDeviceModel":"Example Model","Latitude":"0.00000","Longitude":"0.00000","BrowserLanguage": "Example Language","FullUserAgent":"Example Full User Agent","Referrer": "Example Referrer","ClickDate":"2014-11-19T17:48:26.155Z","ActionUrl": "Example URL","ActionName":"Example Name","Email":"Example Email" } | |
| Response body | |
| { "ID":1,"LinkID":0,"RefID":0,"OwnerID":0,"DeviceID":0,"IPAddress": 0.0.0.0,"UserAgent":"Example User Agent","Browser": "Example Browser","Version":"Example Version","IsMobile":false, "MobileDeviceManufacturer":"Example Manufacturer","MobileDeviceModel": "Example Model","Latitude":0.00000,"Longitude":0.00000,"BrowserLanguage": "Example Language","FullUserAgent":"Example Full User Agent","Referrer": "Example Referrer","ClickDate":"2014-12-01T01:14:22.155Z","ActionUrl": "Example URL","ActionName":"Example Name","Email":"Example Email" } | |
| Deleting a Click | |
| Request | |
| DELETE /api/odata/Clicks(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a Click | |
| Request | |
| GET /api/odata/Clicks(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"LinkID":0,"RefID":0,"OwnerID":0,"DeviceID":0,"IPAddress":0.0.0.0,"UserAgent": "Example User Agent","Browser":"Example Browser","Version": "Example Version","IsMobile":false,"MobileDeviceManufacturer": "Example Manufacturer","MobileDeviceModel":"Example Model","Latitude":0.00000,"Longitude":0.00000,"BrowserLanguage": "Example Language","FullUserAgent":"Example Full User Agent","Referrer": "Example Referrer","ClickDate":"2014-12-01T01:14:22.155Z","ActionUrl": "Example URL","ActionName":"Example Name","Email":"Example Email" } | |
| Updating a Click | |
| Request | |
| PUT /api/odata/Clicks(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","LinkID":"0","RefID":"0","OwnerID":"0","DeviceID":"0","IPAddress": "0.0.0.0","UserAgent":"Example User Agent","Browser": "Example Browser","Version":"Example Version","IsMobile":true, "MobileDeviceManufacturer": "Example Manufacturer","MobileDeviceModel":"Example Model","Latitude":"0.00000","Longitude":"0.00000","BrowserLanguage":"Example Language","FullUserAgent":"Example Full User Agent","Referrer":"Example Referrer","ClickDate":"2014-11-19T17:48:26.155Z","ActionUrl":"Example URL","ActionName":"Example Name","Email":"Example Email" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Clicks | |
| Request | |
| GET /api/odata/Clicks | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":0,"LinkID":0,"RefID":0,"OwnerID":0,"DeviceID":0, "IPAddress":0.0.0.0,"UserAgent":"Example User Agent","Browser": "Example Browser","Version":"Example Version","IsMobile":true,"MobileDeviceManufacturer": "Example Manufacturer","MobileDeviceModel":"Example Model","Latitude":0.00000,"Longitude":0.00000,"BrowserLanguage": "Example Language","FullUserAgent":"Example Full User Agent","Referrer": "Example Referrer","ClickDate":"2014-11-19T17:48:26.155Z","ActionUrl": "Example URL","ActionName":"Example Name","Email":"Example Email" },{ "ID":1,"LinkID":0,"RefID":0,"OwnerID":0,"DeviceID":0, "IPAddress":0.0.0.0,"UserAgent":"Example User Agent","Browser": "Example Browser","Version":"Example Version","IsMobile":false,"MobileDeviceManufacturer":"Example Manufacturer","MobileDeviceModel":"Example Model","Latitude":0.00000,"Longitude":0.00000,"BrowserLanguage": "Example Language","FullUserAgent":"Example Full User Agent","Referrer": "Example Referrer","ClickDate":"2014-12-01T01:14:22.155Z","ActionUrl": "Example URL","ActionName":"Example Name","Email":"Example Email" }] | |
