• Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Login
    EN CS
Mailkit logo
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Login
    EN CS
EN CS
Login
  • Mailkit
  • Resources
  • API documentation
  • Reporting
  • mailkit.report.message.links.visitors
    API Introduction
  • Campaign management (11)
    mailkit.campaigns.list mailkit.campaigns.create mailkit.campaigns.update mailkit.campaigns.single.schedule mailkit.campaigns.schedule.list mailkit.campaigns.schedule.timezone mailkit.campaigns.schedule.cancel mailkit.campaigns.messages mailkit.campaigns.messages.last mailkit.campaigns.messages.test mailkit.campaigns.history
  • Mailing list management (18)
    mailkit.mailinglist.list mailkit.mailinglist.create mailkit.mailinglist.delete mailkit.mailinglist.adduser mailkit.mailinglist.edituser mailkit.mailinglist.import mailkit.mailinglist.getstatus mailkit.mailinglist.unsubscribed mailkit.mailinglist.engagement mailkit.email.getstatus mailkit.email.getstatus.history mailkit.email.move mailkit.email.delete mailkit.email.unsubscribe mailkit.email.unsubscribe.getstatus mailkit.email.revalidate mailkit.email.topics mailkit.email.wipe
  • Campaign delivery (4)
    mailkit.sendmail mailkit.sendmail_mass mailkit.sendmail_mass.results mailkit.sendsms
  • Reporting (11)
    mailkit.report mailkit.report.campaign mailkit.report.message mailkit.report.message.recipients mailkit.report.message.feedback mailkit.report.message.links mailkit.report.message.links.visitors mailkit.report.message.bounces mailkit.report.raw.messages mailkit.report.raw.bounces mailkit.report.raw.responses
  • Profile (2)
    mailkit.profile.emails.list mailkit.profile.queries.list
  • Other (4)
    Event API mailkit.filemanager.upload mailkit.filemanager.list mailkit.filemanager.delete
  • Examples (3)
    PHP example 1 (Example of mailkit.mailinglist.list call) PHP example 2 (example of mailkit.campaigns.single.schedule call) PERL example of mailkit.mailinglist.adduser call
  • API Introduction
  • Campaign management
  • Mailing list management
  • Campaign delivery
  • Reporting
  • Profile
  • Other
  • Examples
API Introduction
mailkit.campaigns.list mailkit.campaigns.create mailkit.campaigns.update mailkit.campaigns.single.schedule mailkit.campaigns.schedule.list mailkit.campaigns.schedule.timezone mailkit.campaigns.schedule.cancel mailkit.campaigns.messages mailkit.campaigns.messages.last mailkit.campaigns.messages.test mailkit.campaigns.history
mailkit.mailinglist.list mailkit.mailinglist.create mailkit.mailinglist.delete mailkit.mailinglist.adduser mailkit.mailinglist.edituser mailkit.mailinglist.import mailkit.mailinglist.getstatus mailkit.mailinglist.unsubscribed mailkit.mailinglist.engagement mailkit.email.getstatus mailkit.email.getstatus.history mailkit.email.move mailkit.email.delete mailkit.email.unsubscribe mailkit.email.unsubscribe.getstatus mailkit.email.revalidate mailkit.email.topics mailkit.email.wipe
mailkit.sendmail mailkit.sendmail_mass mailkit.sendmail_mass.results mailkit.sendsms
mailkit.report mailkit.report.campaign mailkit.report.message mailkit.report.message.recipients mailkit.report.message.feedback mailkit.report.message.links mailkit.report.message.links.visitors mailkit.report.message.bounces mailkit.report.raw.messages mailkit.report.raw.bounces mailkit.report.raw.responses
mailkit.profile.emails.list mailkit.profile.queries.list
Event API mailkit.filemanager.upload mailkit.filemanager.list mailkit.filemanager.delete
PHP example 1 (Example of mailkit.mailinglist.list call) PHP example 2 (example of mailkit.campaigns.single.schedule call) PERL example of mailkit.mailinglist.adduser call
Search

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:

  • JSON
  • XML
{  
   "function":"mailkit.report.message.links.visitors",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
        "ID_send":"ID_send",
        "ID_url":"ID_url"
   }
}
<?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
  • XML
[
  {
    "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"
  }
]
<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
  • XML
{  
   "error_status":"1",
   "error":"Invalid ID_send"
}
<?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

Contact us

Let us know what your campaign objectives are and we'll create a plan that works for you.

+420 277 001 800
sales@mailkit.com


Processing of information provided using this form is governed by our Privacy Policy.

Required
Required
Required
Mailkit logo

A Czech emailing platform with its own infrastructure, that is a leader in international mailing distribution.

 

  • Features
  • Services
  • Resources
  • About us

services

  • Email Authentication
  • Agency Partnerships
  • Email Training
  • Inbox Brand Visibility
  • Deliverability

ReSOURCES

  • Knowledge Base
  • API documentation
  • Blog
  • Status
  • BIMI inspector
Logo Maawg
Logo Experience
Logo CSA
Logo Signal spam
Logo ISO-27001
Logo ISO-9001
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
© 2006-2022 Mailkit - All rights reserved