ResourcesAPI documentation

mailkit.report.raw.messages

Function mailkit.report.raw.messages returns complete raw records about all message recipients and sent messages.

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 standard integration where recursive queries of mailkit.report.message are recommended. It will be necessary to iterrate through records using ID_send_message key as this function's response is limited to 25000 records per query.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.raw.messages</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>limit</int>
      </value>
    </param>
  </params>
</methodCall>

JSON

{  
   "function":"mailkit.report.raw.messages",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
        "ID_message":"12345",
        "ID_send": "123456",
        "ID_send_message": "123456789",
        "limit":"1000"
   }
}

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_message * = Campaign ID
ID_send = Campaign delivery ID 
ID_send_message = initial record ID to start from - used for iterration
limit = number of records to retrieve (defaults to 25000).

* required value

Succesfull call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>ID_message</name>
                  <value>
                    <i4>32443</i4>
                  </value>
                </member>
                <member>
                  <name>ID_send</name>
                  <value>
                    <i4>601181</i4>
                  </value>
                </member>
                <member>
                  <name>ID_send_message</name>
                  <value>
                      <i4>723043605</i4>
                  </value>
                </member>
                <member>
                  <name>ID_user_list</name>
                  <value>
                    <i4>46061</i4>
                  </value>
                </member>
                <member>
                  <name>ID_email</name>
                  <value>
                    <i4>351431738</i4>
                  </value>
                </member>
                <member>
                  <name>ID_template</name>
                  <value>
                    <i4>3858</i4>
                  </value>
                </member>
                <member>
                  <name>type_message</name>
                  <value>
                    <string>email</string>
                  </value>
                </member>
                <member>
                  <name>email</name>
                  <value>
                    <string>0100marc@seznam.cz</string>
                  </value>
                </member>
                <member>
                  <name>email_date</name>
                  <value>
                    <string>2016-02-16 04:30:15</string>
                  </value>
                </member>
                <member>
                  <name>message_date</name>
                  <value>
                    <string>2016-06-20 14:37:47</string>
                  </value>
                </member>
                <member>
                  <name>date_sent</name>
                  <value>
                    <string>2016-06-20 16:07:00</string>
                  </value>
                </member>
                <member>
                  <name>ab_version</name>
                  <value>
                    <string>A</string>
                  </value>
                </member>
                <member>
                  <name>message_status</name>
                  <value>
                    <string>sent</string>
                  </value>
                </member>
                <member>
                  <name>tld</name>
                  <value>
                    <string>cz</string>
                  </value>
                </member>
                <member>
                  <name>domain</name>
                  <value>
                    <string>seznam.cz</string>
                  </value>
                </member>
                <member>
                  <name>custom_1</name>
                  <value>
                    <i4>520636</i4>
                  </value>
                </member>
                <member>
                  <name>custom_2</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>custom_3</name>
                  <value>
                    <string>2016-02-15 14:52:22+01</string>
                  </value>
                </member>
                <member>
                  <name>custom_4</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>custom_5</name>
                  <value>
                      <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>custom_6</name>
                  <value>
                    <i4>4</i4>
                  </value>
                </member>
                <member>
                  <name>custom_7</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>custom_8</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>custom_9</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>custom_10</name>
                  <value>
                    <i4>927</i4>
                  </value>
                </member>
                <member>
                  <name>custom_11</name>
                  <value>
                    <i4>69</i4>
                  </value>
                </member>
                <member>
                  <name>custom_12</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>custom_13</name>
                  <value>
                    <string>Znojmo</string>
                  </value>
                </member>
                <member>
                  <name>custom_14</name>
                  <value>
                    <string>Nároční</string>
                  </value>
                </member>
                <member>
                  <name>custom_15</name>
                  <value>
                    <i4>6</i4>
                  </value>
                </member>
                <member>
                  <name>custom_16</name>
                  <value>
                      <i4>99220</i4>
                  </value>
                </member>
                <member>
                  <name>custom_17</name>
                  <value>
                    <i4>3667</i4>
                  </value>
                </member>
                <member>
                  <name>custom_18</name>
                  <value>
                    <i4>2206</i4>
                  </value>
                </member>
                <member>
                  <name>custom_19</name>
                  <value>
                    <i4>69</i4>
                  </value>
                </member>
                <member>
                  <name>custom_20</name>
                  <value>
                    <i4>99220</i4>
                  </value>
                </member>
                <member>
                  <name>custom_21</name>
                  <value>
                    <i4>6</i4>
                  </value>
                </member>
                <member>
                  <name>custom_22</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>custom_23</name>
                  <value>
                    <string>2016-02-15</string>
                  </value>
                </member>
                <member>
                  <name>custom_24</name>
                  <value>
                    <string>2016-02-15</string>
                  </value>
                </member>
                <member>
                  <name>custom_25</name>
                  <value>
                    <i4>2206</i4>
                  </value>
                </member>
                <member>
                  <name>prefix</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>vocative</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>first_name</name>
                  <value>
                    <string>marketa</string>
                  </value>
                </member>
                <member>
                  <name>last_name</name>
                  <value>
                    <string>fialova</string>
                  </value>
                </member>
                <member>
                  <name>full_name</name>
                  <value>
                    <string>marketa fialova</string>
                  </value>
                </member>
                <member>
                  <name>nick_name</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>gender</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>reply_to</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>company</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>street</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>city</name>
                  <value>
                    <string>suchohrdly =znojmo</string>
                  </value>
                </member>
                <member>
                  <name>state</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>country</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>zip</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>phone</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>mobile</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>fax</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>s_continent</name>
                  <value>
                    <string>europe</string>
                  </value>
                </member>
                <member>
                  <name>s_country</name>
                  <value>
                    <string>Czech Republic</string>
                  </value>
                </member>
                <member>
                  <name>s_region</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>s_city</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>s_org</name>
                  <value>
                    <string>Seznam.cz, a.s.</string>
                  </value>
                </member>
                <member>
                  <name>s_browser</name>
                  <value>
                    <string>Email.cz</string>
                  </value>
                </member>
                <member>
                  <name>s_os</name>
                  <value>
                    <string></string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[
  {
    "ID_message": "123456",
    "ID_send": "123456",
    "ID_send_message": "1234567890",
    "ID_user_list": "",
    "ID_email": "1234567890",
    "ID_template": "",
    "type_message": "email",
    "email": "email@example.com",
    "email_date": "2001-01-01 01:01:01",
    "message_date": "2016-01-01 01:01:00",
    "date_sent": "2016-01-01 01:01:01",
    "ab_version": "",
    "message_status": "sent",
    "tld": "com",
    "domain": "example.com",
    "custom_1": "",
    "custom_2": "",
    "custom_3": "",
    "custom_4": "",
    "custom_5": "",
    "custom_6": "",
    "custom_7": "",
    "custom_8": "",
    "custom_9": "",
    "custom_10": "",
    "custom_11": "",
    "custom_12": "",
    "custom_13": "",
    "custom_14": "",
    "custom_15": "",
    "custom_16": "",
    "custom_17": "",
    "custom_18": "",
    "custom_19": "",
    "custom_20": "",
    "custom_21": "",
    "custom_22": "",
    "custom_23": "",
    "custom_24": "",
    "custom_25": "",
    "prefix": "",
    "vocative": "",
    "first_name": "Vigor",
    "last_name": "Tester",
    "full_name": "Vigor Tester",
    "nick_name": "",
    "gender": "",
    "reply_to": "",
    "company": "",
    "street": "",
    "city": "",
    "state": "",
    "country": "",
    "zip": "",
    "phone": "",
    "mobile": "",
    "fax": "",
    "s_continent": "europe",
    "s_country": "Czech Republic",
    "s_region": "Prazsky",
    "s_city": "",
    "s_org": "Mailkit s.r.o.",
    "s_browser": "Thunderbird",
    "s_os": "Windows"
  }
]

Values

ID_message - Campaign ID
ID_send - Campaign delivery ID
ID_send_message - Sent message ID (unique)
ID_user_list - Mailing list ID
ID_email - E-mail address ID
ID_template - ID of template used
type_message - message type
email - recipient's email address
email_date - date email address has been added to mailing list
message_date - date and time message has been scheduled for delivery
date_sent - date and time message has been sent
ab_version - message version in case of A/B test
message_status - message delivery status - sent, failed for bounces, wait for messages pending delivery (or wait_ab for A/B testing)
tld - top-level domain of recipient
domain - domain of recipient
custom_1 - value of recipient's CUSTOM1 field
custom_2 - value of recipient's CUSTOM2 field
custom_3 - value of recipient's CUSTOM3 field
custom_4 - value of recipient's CUSTOM4 field
custom_5 - value of recipient's CUSTOM5 field
custom_6 - value of recipient's CUSTOM6 field
custom_7 - value of recipient's CUSTOM7 field
custom_8 - value of recipient's CUSTOM8 field
custom_9 - value of recipient's CUSTOM9 field
custom_10 - value of recipient's CUSTOM10 field
custom_11 - value of recipient's CUSTOM11 field
custom_12 - value of recipient's CUSTOM12 field
custom_13 - value of recipient's CUSTOM13 field
custom_14 - value of recipient's CUSTOM14 field
custom_15 - value of recipient's CUSTOM15 field
custom_16 - value of recipient's CUSTOM16 field
custom_17 - value of recipient's CUSTOM17 field
custom_18 - value of recipient's CUSTOM18 field
custom_19 - value of recipient's CUSTOM19 field
custom_20 - value of recipient's CUSTOM20 field
custom_21 - value of recipient's CUSTOM21 field
custom_22 - value of recipient's CUSTOM22 field
custom_23 - value of recipient's CUSTOM23 field
custom_24 - value of recipient's CUSTOM24 field
custom_25 - value of recipient's CUSTOM25 field
prefix - recipient's title
vocative - recipient's vocative
first_name - recipient's first name
last_name - recipient's last name
full_name - recipient's full name
nick_name - recipient's nickname
gender - recipient's gender
reply_to - reply-to address
company - recipient's company
street - recipient's street
city - recipient's city
state - recipient's state
country - recipient's country
zip - recipient's ZIP code
phone - recipient's phone number
mobile - recipient's mobile phone number
fax - recipient's fax number
s_continent - continent - collected geolocation information
s_country - country - collected geolocation information
s_region - region - collected geolocation information
s_city - city - collected geolocation information
s_org - organization - collected geolocation information
s_browser - browser - collected information
s_os - operating system - collected information