ResourcesAPI documentation

mailkit.report.message

Function mailkit.report.message returns reports overview for a specified campaign delivery.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message</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",
   "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>
        <struct>
          <member>
            <name>SEND_COUNT</name>
            <value>
              <i4>2</i4>
            </value>
          </member>
          <member>
            <name>SUBJECT</name>
            <value>
              <string>Campaign subject</string>
            </value>
          </member>
          <member>
            <name>FAILED_COUNT</name>
            <value>
              <string></string>
            </value>
          </member>
          <member>
            <name>READ_COUNT</name>
            <value>
              <i4>2</i4>
            </value>
          </member>
          <member>
            <name>CLICK_COUNT</name>
            <value>
              <i4>1</i4>
            </value>
          </member>
          <member>
            <name>MINIPAGE_CLICK_COUNT</name>
            <value>
              <i4>0</i4>
            </value>
          </member>
          <member>
            <name>CONVERSION_COUNT_U</name>
            <value>
              <i4>0</i4>
            </value>
          </member>
          <member>
            <name>CONVERSION_COUNT</name>
            <value>
              <i4>0</i4>
            </value>
          </member>
          <member>
            <name>DELIVERED_COUNT</name>
            <value>
              <i4>2</i4>
            </value>
          </member>
          <member>
            <name>READ_COUNT_U</name>
            <value>
              <i4>1</i4>
            </value>
          </member>
          <member>
            <name>SEND_DATE</name>
            <value>
              <string>yyyy-mm-dd hh:mm:ss</string>
            </value>
          </member>
          <member>
            <name>CLICK_COUNT_U</name>
            <value>
              <i4>1</i4>
            </value>
          </member>
          <member>
            <name>UTM</name>
            <value>
              <string>Campaign-name-20181012</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

JSON

{
  "SEND_COUNT": "2",
  "SUBJECT": "Campaign subject",
  "FAILED_COUNT": "0",
  "READ_COUNT": "2",
  "CLICK_COUNT": "1",
  "MINIPAGE_CLICK_COUNT": "0",
  "CONVERSION_COUNT_U": "0",
  "CONVERSION_COUNT": "0",
  "DELIVERED_COUNT": "2",
  "READ_COUNT_U": "1",
  "SEND_DATE": "YYYY-MM-DD HH:MM:SS",
  "CLICK_COUNT_U": "1"
  "UTM": "Campaign-name-20181012"
}

Values

SEND_DATE = message send date
SUBJECT = message subject
SEND_COUNT = number of messages sent
DELIVERED_COUNT = number of messages delivered
FAILED_COUNT = number of bounced messages
READ_COUNT = read count
READ_COUNT_U = open count (unique reads)
CLICK_COUNT = click count
CLICK_COUNT_U = visit count (unique clicks)
CONVERSION_COUNT = conversion count
CONVERSION_COUNT_U = unique conversion count
MINIPAGE_CLICK_COUNT = microsite link click count
UTM = UTM campaign name used in message