API call example:
JSON
{
"function":"mailkit.report.message.feedback",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"period":"DAY/WEEK/MONTH",
"ID_send":"ID_send"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.report.message.feedback</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>
<param>
<value>
<string>DAY/WEEK/MONTH</string>
</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
DAY/WEEK/MONTH = data range from the time of campaign has been sent. Default value (DAY)
* required value
Successful call response:
JSON
[
{
"VISIT": 0,
"OPEN": "44",
"UNSUBSCRIBE": 0,
"OPEN_P": "44",
"DATE": "RRRR-MM-DD",
"CLICK": 0,
"SPAM_REPORT": 0,
"VISIT_P": 0,
"READ": "58"
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>DATE</name>
<value>
<string>2013-12-30 10:00</string>
</value>
</member>
<member>
<name>READ</name>
<value>
<i4>350</i4>
</value>
</member>
<member>
<name>OPEN</name>
<value>
<i4>305</i4>
</value>
</member>
<member>
<name>OPEN_P</name>
<value>
<i4>305</i4>
</value>
</member>
<member>
<name>CLICK</name>
<value>
<i4>183</i4>
</value>
</member>
<member>
<name>VISIT</name>
<value>
<i4>112</i4>
</value>
</member>
<member>
<name>VISIT_P</name>
<value>
<i4>112</i4>
</value>
</member>
<member>
<name>UNSUBSCRIBE</name>
<value>
<i4>23</i4>
</value>
</member>
<member>
<name>SPAM_REPORT</name>
<value>
<i4>1</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
DATE = time range of period (hour/day) (eg. for value 2013-12-30 10:00 the data (when requestion DAY or WEEK) are the whole hour range from 2013-12-30 10:00 to 2013-12-30 10:59). In case of MONTH range the DATE will return the data of the whole day.
READ = read count
OPEN = open count (unique read count in chosen period DAY/WEEK/MONTH)
OPEN_P = open count (unique read count within range - HOUR/DAY)
CLICK = click count
VISIT = visit count (unique read count in chosen period DAY/WEEK/MONTH)
VISIT_P = visit count (unique read count within range - HOUR/DAY)
UNSUBSCRIBE = unsubscribe count
SPAM_REPORT = spam report count
This sample shows only a shortened reponse for illustration. Full response would contain data for all 24 hours since the campaign has been sent. Data is presented only for hours/days where activity has been recorded. In DAY/WEEK range the hours where no activity has been recorded (eg. at night time) will not be present at all (not even null).
Unsuccessful call response:
JSON
{
"error_status": 1,
"error": "Invalid period"
}
XML
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid period</string>
</value>
</param>
</params>
</methodResponse>
Values
Missing ID_send – missing campaign delivery ID
Invalid ID_send – invalid campaign delivery ID
Invalid period – invalid value for data range (DAY/WEEK/MONTH)
