ResourcesAPI documentation

mailkit.report.message.links

Function mailkit.report.message.links returns a success report for all links in a specified campaign delivery.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message.links</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_send</int>
      </value>
    </param>
  </params>
</methodCall>

JSON

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

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.
client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.
ID_send * = Campaign delivery ID 

* required value

Succesfull call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>URL</name>
                  <value>
                    <string>http://www.nejakaadresa.cz/nekde</string>
                  </value>
                </member>
                <member>
                  <name>ID_URL</name>
                  <value>
                    <i4>1234567</i4>
                  </value>
                </member>
                <member>
                  <name>TITLE</name>
                  <value>
                    <string>logo.gif</string>
                  </value>
                </member>
                <member>
                  <name>TITLE_SHORT</name>
                  <value>
                    <string>logo.gif</string>
                  </value>
                </member>
                <member>
                  <name>VISIT</name>
                  <value>
                    <i4>112</i4>
                  </value>
                </member>
                <member>
                  <name>CLICK</name>
                  <value>
                    <i4>167</i4>
                  </value>
                </member>
                <member>
                  <name>CONVERSION</name>
                  <value>
                    <i4>23</i4>
                  </value>
                </member>
                <member>
                  <name>ID_GROUP</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[
  {
    "CONVERSION": "0",
    "TITLE_SHORT": "Klikněte zde pro zobrazení webové verze newsletter ...",
    "URL": "http://www.nejakaadresa.cz/nekde",
    "VISIT": "1",
    "ID_URL": "123456789",
    "TITLE": "Klikněte zde pro zobrazení webové verze newsletteru.",
    "ID_GROUP": "0",
    "COUNT": "1"
  }
]

Values

URL = link target URL address
ID_URL = ID of url address
TITLE = link title
TITLE_SHORT = shortened link title
CLICK = click count
VISIT = visit count (unique clicks)
CONVERSION = conversion count
ID_GROUP = tracking group ID

This sample only contains a shortened response. Complete response would contain data for all individual links in the campaign that have been clicked at.