This function is intended for complete data transfer to external database systems. Due to large amount of data being transferred, query frequency limits and delays we strongly DISCOURAGE use of this function for interactive integration where recursive queries of mailkit.report.message are recommended. It will be necessary to iterrate through records using ID_log key as this function's response is limited to 25000 records per query.
API call example:
JSON
{
"function":"mailkit.report.raw.responses",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_message":"12345",
"ID_send":"12345",
"ID_send_message":"123456798",
"limit":"1234",
"ID_log":"123456789"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.report.raw.responses</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>ID_message</int>
</value>
</param>
<param>
<value>
<int>ID_send</int>
</value>
</param>
<param>
<value>
<int>ID_send_message</int>
</value>
</param>
<param>
<value>
<int>ID_log</int>
</value>
</param>
<param>
<value>
<int>limit</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_message = Campaign ID
ID_send = Campaign delivery ID
ID_send_message = ID of a specific message
ID_log = initial record ID to start from - used for iterration
limit = number of records to retrieve (defaults to 25000).
* required value
Succesfull call response:
JSON
[
{
"date": "2001-01-01 01:01:01",
"email": "email@example.com",
"ID_email": "1234567890",
"ID_user_list": "12345",
"ID_message": "12345"
"ID_send": "123456",
"ID_send_message": "1234567890",
"ID_log": "2001011234567980",
"ab_version": "",
"domain": "example.com",
"tld": "com",
"type": "click",
"ID_url": "1234567",
"link_type": "href",
"link_url": "http://www.example.com/about/",
"link_text": "About",
"link_title": "",
"referer": "",
"unsubscribe_answer": "0",
"IP": "123.123.123.123",
"IP_orig": "123.123.123.123",
"continent": "europe",
"country": "Czech Republic",
"code3": "CZE",
"code": "CZ",
"region": "Prazsky",
"region_code": "0",
"city": "Praha",
"user_agent": "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36",
"browser": "Chrome",
"browser_major": "44",
"browser_minor": "0",
"browser_type": "Browser",
"os": "Windows",
"os_version": "8.1",
"device": "Personal computer",
"org": "Sample internet provider",
}
]
XML
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>date</name>
<value>
<string>2001-01-01 01:01:01</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>email@example.com</string>
</value>
</member>
<member>
<name>ID_email</name>
<value>
<i4>1234567890</i4>
</value>
</member>
<member>
<name>ID_user_list</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>ID_message</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>ID_send</name>
<value>
<i4>123456</i4>
</value>
</member>
<member>
<name>ID_send_message</name>
<value>
<i4>1234567890</i4>
</value>
</member>
<member>
<name>ID_log</name>
<value>
<i4>2001011234567890</i4>
</value>
</member>
<member>
<name>ab_version</name>
<value>
<string></string>
</value>
</member>
<member>
<name>domain</name>
<value>
<string>example.com</string>
</value>
</member>
<member>
<name>tld</name>
<value>
<string>com</string>
</value>
</member>
<member>
<name>type</name>
<value>
<string>click</string>
</value>
</member>
<member>
<name>ID_url</name>
<value>
<i4>1234567</i4>
</value>
</member>
<member>
<name>link_type</name>
<value>
<string>href</string>
</value>
</member>
<member>
<name>link_url</name>
<value>
<string>http://www.example.com/about/</string>
</value>
</member>
<member>
<name>link_text</name>
<value>
<string>About</string>
</value>
</member>
<member>
<name>link_title</name>
<value>
<string></string>
</value>
</member>
<member>
<name>referer</name>
<value>
<string></string>
</value>
</member>
<member>
<name>unsubscribe_answer</name>
<value>
<i4>0</i4>
</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>continent</name>
<value>
<string>europe</string>
</value>
</member>
<member>
<name>country</name>
<value>
<string>Czech Republic</string>
</value>
</member>
<member>
<name>code3</name>
<value>
<string>CZE</string>
</value>
</member>
<member>
<name>code</name>
<value>
<string>CZ</string>
</value>
</member>
<member>
<name>region</name>
<value>
<string>Prazsky</string>
</value>
</member>
<member>
<name>region_code</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>Praha</string>
</value>
</member>
<member>
<name>user_agent</name>
<value>
<string>Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36</string>
</value>
</member>
<member>
<name>browser</name>
<value>
<string>Chrome</string>
</value>
</member>
<member>
<name>browser_major</name>
<value>
<string>44</string>
</value>
</member>
<member>
<name>browser_minor</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>browser_type</name>
<value>
<string>Browser</string>
</value>
</member>
<member>
<name>os</name>
<value>
<string>Windows</string>
</value>
</member>
<member>
<name>os_version</name>
<value>
<string>8.1</string>
</value>
</member>
<member>
<name>device</name>
<value>
<string>Personal computer</string>
</value>
</member>
<member>
<name>org</name>
<value>
<string>Sample internet provider</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
date - date of response
email - recipient's email address
ID_email - E-mail address ID
ID_user_list - Mailing list ID
ID_message - Campaign ID
ID_send - Campaign delivery ID
ID_send_message - Sent message ID
ID_log - Log record ID used for itteration
ab_version - message version in case of A/B test
domain - domain of recipient
tld - top-level domain of recipient
type - response type:
- read - message read
- botread - reading a message that has been evaluated as non-human (robotic) interaction
- click - link clicked in a message
- botclick - click that has been evaluated as non-human (robotic) interaction
- unsubscribe - recipient unsubscribed
conversion - conversion (old conversion tracking method)- spam_report - spam report
- forward - message forwarded
- print - message printout
- share - message shared
- polls_click - voted in a poll
- polls - displayed a poll
ID_url - URL address ID
link_type - link type (href or form)
link_url - URL address of the target page
link_text - text title of the link in the e-mail
link_title - title value of the link
referer - referrer URL of the visit (only available for redirected clicks)
note – unsubscribe method (for records with type=unsubscribe):
- oneclick = One-click unsubscribe
- unsubscribe.pl = MUA unsubscribe
- user.fcgi = the recipient has unsubscribe using the unsubscribe link in the sent message
- own (other) reason given by the recipient when unsubscribing (see unsubscribe_answer with value 6 below)
unsubscribe_answer - recipient provided reason to unsubsribe (for records with type=unsubscribe) - defaults:
- 0 - no reason provided
- 1 - no longer interrested
- 2 - receiving too many messages
- 3 - never signed up
- 4 - emails are inappropriate
- 5 - emails are a spam
- 6 - other reason
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)
continent - recipient's continent
country - country name identified using GeoIP
code3 - country code ISO 3166-1 alpha-3
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
user_agent - user agent string of the browser
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)
os - operating system from USER_AGENT
os_version - operating system version
device - device type identified from USER_AGENT
org - organisation providing internet access
In case there are no recipient responses, the API returns an empty response:
JSON
{}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Unsuccessful call response:
JSON
{
"error_status": 1,
"error": "Invalid ID_message"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid ID_log format</string>
</value>
</param>
</params>
</methodResponse>
Values
Invalid ID_message – invalid campaign ID
Invalid ID_send – invalid campaign delivery ID
Invalid ID_log format – invalid format of initial record ID
In other cases, the API returns an empty response, or "Error":
JSON
{
"error_status": 1,
"error": "Error"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
