ResourcesAPI documentation

mailkit.mailinglist.engagement

Function mailkit.mailinglist.engagement provides access to information about the engagement scoring of individual recipients.

The intended use is to itterate using ID_email through all recipients and retrieve there current score at the time of query. Since engagement scores are changing over time it is necessary to refetch the data starting from 0. While the scores are recalculated with every user's action the public output of engagement score both in the API and user interface are updated once a day. Consumers of the data should not try to query the data more then once a day as they can be subject to API throttling.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.mailinglist.engagement</methodName>
    <params>
    <param>
      <value><int>client_id</int></value>
    </param>
    <param>
      <value><string>client_md5</string></value>
    </param>
    <param>
      <value><i4>ID_user_list</i4></value>
    </param>
    <param>
      <value><i4>ID_email</i4></value>
    </param>
    <param>
      <value><i4>limit</i4></value>
    </param>
  </params>
</methodCall>

JSON

{
  "function": "mailkit.mailinglist.engagement",
  "id": "client_id",
  "md5": "client_md5",
  "parameters": {
    "ID_user_list": "12345", 
    "ID_email": "123456789",
    "limit": 100
  }
}

Values

client_id * = API 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_user_list * = ID of mailing list
ID_email = ID of email address
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>SCORE</name>
                <value><i4>5</i4></value>
            </member>
            <member>
              <name>ID_EMAIL</name>
                <value><i4>123456789</i4></value>
            </member>
            <member>
              <name>TREND</name>
                <value><i4>2</i4></value>
            </member>
            <member>
              <name>EMAIL</name>
                <value><string>example@example.eu</string></value>
            </member>
           </struct>
         </value>
         </data>
         </array>
       </value>
     </param>
   </params>
</methodResponse>

JSON

[
  {
    "TREND": 2,
    "SCORE": 5,
    "EMAIL": "example@example.eu",
    "ID_EMAIL": 123456
  }
]

Values:

EMAIL - email address of the recipient
ID_EMAIL - ID of email address
SCORE - engagement score (value between between 0-5, higher the score the better)
TREND - engagement trend (values are -2, -1 for negative trend, 0 for neutral and 1, 2 for positive trend)