mailkit.mailinglist.engagement

Funkce mailkit.mailinglist.engagement vrací engagement skóre příjemců v seznamu.

Tato funkce je určena k iteraci pomocí ID_email napříč všemi příjemci za účelem získání informace o jejich engagement score v okamžiku dotazu. Protože se engagement score v čase mění, je nezbytné tato data průběžně stahovat a aktulizovat od nuly. I přesto, že skore příjemců je přepočítáváno s každou jejich aktivitou, zveřejněné hodnoty jak v API tak v uživatelském rozhraní se aktualizují jednou denně. Zákazníci, kteří odebírají data, by neměli provádět aktualizaci častěji než jednou denně. V případě častějších požadavků může dojít k automatickému omezování API rozhraní.

Ukázka API volání:

JSON 

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

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>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_user_list * = ID seznamu příjemců
ID_email = ID e-mailu
limit = počet záznamů, které chcete přenést (standardně 25000)

* povinný parametr

Po úspěšném volání se vrací:

JSON 

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

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>

Hodnoty:

EMAIL – e-mailová adresa
ID_EMAIL – ID e-mailu
SCORE – engagement skóre (může nabývat hodnot 0-5, čím vyšší hodnota tím vyšší engagement)
TREND – engagement trend (může nabývat hodnot -2, -1 pro negativní trend, 0 pro neutrální a 1, 2 pro pozitivní trend)

Po neúspěšném volání se vrací:

JSON 

{
    "error": "Invalid ID_user_list",
    "error_status": 1
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Missing ID_mailing_list</string>
            </value>
        </param>
    </params>
</methodResponse>

Hodnoty:

Invalid ID_user_list = neplatné číslo seznamu příjemců
Missing ID_user_list = chybějící číslo seznamu příjemců (JSON)
Missing ID_mailing_list = chybějící číslo seznamu příjemců (XML)