API call example:
JSON
{
"function":"mailkit.report.message.links",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_send":"ID_send"
}
}
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>
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
* required value
Succesfull call response:
JSON
[
{
"TITLE": "Lorem ipsum",
"TITLE_SHORT": "Lorem ipsum lips",
"ANCHOR": "drinks 2.jpg",
"URL": "http://www.sampleurl.site/",
"ID_URL": 123456,
"AB_VERSION": "",
"CLICK": 2,
"VISIT": 1,
"CONVERSION": 1
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>URL</name>
<value>
<string>http://www.sampleurl.site</string>
</value>
</member>
<member>
<name>ID_URL</name>
<value>
<i4>1234567</i4>
</value>
</member>
<member>
<name>TITLE</name>
<value>
<string>Lorem ipsum lips</string>
</value>
</member>
<member>
<name>TITLE_SHORT</name>
<value>
<string>Lorem ipsum</string>
</value>
</member>
<member>
<name>VISIT</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>CLICK</name>
<value>
<i4>2</i4>
</value>
</member>
<member>
<name>CONVERSION</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>AB_VERSION</name>
<value>
<i4></i4>
</value>
</member>
<member>
<name>ANCHOR</name>
<value>
<i4>drinks 2.jpg</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
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
AB_VERSION = version of the campaign in A/B test
ANCHOR = location of the link (image name, text of the link)
This sample only contains a shortened response. Complete response would contain data for all individual links in the campaign that have been clicked at.
Unsuccessful call response:
JSON
{
"error_status": 1,
"error": "Invalid ID_send"
}
XML
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<string>Missing ID_send</string>
</value>
</param>
</params>
</methodResponse>
Values
Missing ID_send – missing campaign delivery ID
Invalid ID_send – invalid campaign delivery ID
