API call example:
JSON
{
"function":"mailkit.report.message.links.visitors",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_send":"ID_send",
"ID_url":"ID_url"
}
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>mailkit.report.message.links.visitors</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<i4>ID_send</i4>
</value>
</param>
<param>
<value>
<i4>ID_url</i4>
</value>
</param>
</params>
</methodCall>
Values
client_id * = client ID can be found in your Mailkit account's menu Profile/Integration.
client_md5 * = MD5 code can be found in your Mailkit account's menu Profile/Integration.
ID_send * = Campaign delivery ID
ID_url * = ID of URL address
* required value
Succesfull call response:
JSON
[
{
"ID_EMAIL": "123456789",
"DATA": {
"COUNTRY": "Czech Republic",
"REGION_CODE": "",
"USER_AGENT": "Mozilla/5.0 (Linux; Android 4.4.4; Lenovo P70-A Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.81 Mobile Safari/537.36",
"CITY": "",
"ORG": "T-Mobile Czech Republic",
"BROWSER_MINOR": "0",
"CODE": "CZ",
"DEVICE": "Smartphone",
"CONTINENT": "europe",
"BROWSER_MAJOR": "51",
"REFERER": "",
"BROWSER": "Chrome Mobile",
"OS": "Android",
"IP": "123.123.123.123",
"IP_ORIG": "123.123.123.123",
"DATETIME": "2001-01-01 01:01:01",
"REGION": "",
"OS_VERSION": "4.4 KitKat",
"BROWSER_TYPE": "Mobile Browser"
},
"COUNT": "1",
"EMAIL": "email@example.com"
},
{
"ID_EMAIL": "123456780",
"DATA": {
"COUNTRY": "Czech Republic",
"REGION_CODE": "52",
"USER_AGENT": "Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko",
"CITY": "Prague",
"ORG": "Sample organization",
"BROWSER_MINOR": "0",
"CODE": "CZ",
"DEVICE": "Personal computer",
"CONTINENT": "europe",
"BROWSER_MAJOR": "11",
"REFERER": "",
"BROWSER": "IE",
"OS": "Windows",
"IP": "123.123.123.234",
"IP_ORIG": "123.123.123.234",
"DATETIME": "2001-01-01 01:01:02",
"REGION": "Hlavni Mesto Praha",
"OS_VERSION": "7",
"BROWSER_TYPE": "Browser"
},
"COUNT": "1",
"EMAIL": "email2@example.com"
}
]
XML
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ID_EMAIL</name>
<value>
<i4>123456789</i4>
</value>
</member>
<member>
<name>DATA</name>
<value>
<struct>
<member>
<name>COUNTRY</name>
<value>
<string>Czech Republic</string>
</value>
</member>
<member>
<name>REGION_CODE</name>
<value>
<string></string>
</value>
</member>
<member>
<name>USER_AGENT</name>
<value>
<string>Mozilla/5.0 (Linux; Android 4.4.4; Lenovo P70-A Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.81 Mobile Safari/537.36</string>
</value>
</member>
<member>
<name>CITY</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ORG</name>
<value>
<string>T-Mobile Czech Republic</string>
</value>
</member>
<member>
<name>BROWSER_MINOR</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>CODE</name>
<value>
<string>CZ</string>
</value>
</member>
<member>
<name>DEVICE</name>
<value>
<string>Smartphone</string>
</value>
</member>
<member>
<name>CONTINENT</name>
<value>
<string>europe</string>
</value>
</member>
<member>
<name>BROWSER_MAJOR</name>
<value>
<i4>51</i4>
</value>
</member>
<member>
<name>REFERER</name>
<value>
<string></string>
</value>
</member>
<member>
<name>BROWSER</name>
<value>
<string>Chrome Mobile</string>
</value>
</member>
<member>
<name>OS</name>
<value>
<string>Android</string>
</value>
</member>
<member>
<name>IP</name>
<value>
<string>123.123.123.123</string>
</value>
</member>
<member>
<name>IP_ORIG</name>
<value>
<string>123.123.123.123</string>
</value>
</member>
<member>
<name>DATETIME</name>
<value>
<string>2001-01-01 01:01:01</string>
</value>
</member>
<member>
<name>REGION</name>
<value>
<string></string>
</value>
</member>
<member>
<name>OS_VERSION</name>
<value>
<string>4.4 KitKat</string>
</value>
</member>
<member>
<name>BROWSER_TYPE</name>
<value>
<string>Mobile Browser</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>COUNT</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>email@example.com</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID_EMAIL</name>
<value>
<i4>123456780</i4>
</value>
</member>
<member>
<name>DATA</name>
<value>
<struct>
<member>
<name>COUNTRY</name>
<value>
<string>Czech Republic</string>
</value>
</member>
<member>
<name>REGION_CODE</name>
<value>
<string></string>
</value>
</member>
<member>
<name>USER_AGENT</name>
<value>
<string>Mozilla/5.0 (Linux; Android 4.4.4; Lenovo P70-A Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.81 Mobile Safari/537.36</string>
</value>
</member>
<member>
<name>CITY</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ORG</name>
<value>
<string>T-Mobile Czech Republic</string>
</value>
</member>
<member>
<name>BROWSER_MINOR</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>CODE</name>
<value>
<string>CZ</string>
</value>
</member>
<member>
<name>DEVICE</name>
<value>
<string>Smartphone</string>
</value>
</member>
<member>
<name>CONTINENT</name>
<value>
<string>europe</string>
</value>
</member>
<member>
<name>BROWSER_MAJOR</name>
<value>
<i4>51</i4>
</value>
</member>
<member>
<name>REFERER</name>
<value>
<string></string>
</value>
</member>
<member>
<name>BROWSER</name>
<value>
<string>Chrome Mobile</string>
</value>
</member>
<member>
<name>OS</name>
<value>
<string>Android</string>
</value>
</member>
<member>
<name>IP</name>
<value>
<string>123.123.123.234</string>
</value>
</member>
<member>
<name>IP_ORIG</name>
<value>
<string>123.123.123.234</string>
</value>
</member>
<member>
<name>DATETIME</name>
<value>
<string>2001-01-01 01:01:02</string>
</value>
</member>
<member>
<name>REGION</name>
<value>
<string></string>
</value>
</member>
<member>
<name>OS_VERSION</name>
<value>
<string>4.4 KitKat</string>
</value>
</member>
<member>
<name>BROWSER_TYPE</name>
<value>
<string>Mobile Browser</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>COUNT</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>email2@example.com</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
ID_EMAIL = ID of e-mail address
COUNT = click count
EMAIL = e-mail address
DATA - array of data about recipient access:
- CONTINENT - recipient's continent
- COUNTRY - country name identified using GeoIP
- CODE - country code ISO 3166-2
- REGION - region name identified using GeoIP
- REGION_CODE - region ID within country identified using GeoIP
- CITY - city identified using GeoIP
- ORG - organisation providing internet access
- BROWSER - browser name from USER_AGENT
- BROWSER_MAJOR - browser major version from USER_AGENT
- BROWSER_MINOR - browser minor version from USER_AGENT
- BROWSER_TYPE - browser type (Browser, Mobile Browser)
- REFERER - referrer URL of the visit (only available for redirected clicks)
- OS - operating system from USER_AGENT
- OS_VERSION - operating system version
- DEVICE - device type identified from USER_AGENT
- IP - IP address of the visitor
- IP_ORIG - IP address of the visitor (may differ from IP if the visitor came from a private network or using proxy server)
- DATETIME - date and time of access
- USER_AGENT - user agent string of the browser
Unsuccessful call response:
JSON
{
"error_status":"1",
"error":"Invalid ID_send"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid ID_send</string>
</value>
</param>
</params>
</methodResponse>
Values
Invalid ID_send = invalid campaign delivery ID
Invalid ID_url = invalid ID of URL
Missing ID_send = missing campaign delivery ID
Missing ID_url = missing ID of URL
