mailkit.report.message.links.visitors

Function mailkit.report.message.links.visitors returns list of e-mail addresses of recipients who clicked on link.

API call example:

{  
   "function":"mailkit.report.message.links.visitors",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
        "ID_send":"ID_send",
        "ID_url":"ID_url"
   }
}

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:

[
  {
    "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"
  }
]

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:

{  
   "error_status":"1",
   "error":"Invalid ID_send"
}

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