API / DeviceCount

Entity Description:

PoliteMail places a DeviceCount cookie on the recipient’s device that is used to open a tracked email. For example, PoliteMail counts the number of devices that was used to open a tracked email. (e.g. iPad, desktop, mobile device, etc…) In other words, the total number of iPads, mobile devices, and desktops that were used to open the email.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
Name
String
Count
Int32


Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a DeviceCount

Request

POST /api/odata/DeviceCounts

Content-Type 

application/json

Request body

{
"ID":"0","Name":"Example Device","Count":"0"
}

Response body

{
"ID":1,"Name":"Example Device","Count":0
}
Deleting a DeviceCount
 Request
 DELETE /api/odata/DeviceCounts(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a DeviceCount
 Request
 GET /api/odata/DeviceCounts(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"Name":"Example Device","Count":0
}
Updating a DeviceCount
 Request
 PUT /api/odata/DeviceCounts(1)
 Content-Type 
 application/json
 Request body
 {
"ID":”0”,"Name":"Example Device","Count":”0”
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all DeviceCounts
 Request
 GET /api/odata/DeviceCounts
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"Name":"Example Device","Count":0
},{
"ID":1,"Name":"Example Device","Count":0
}]