PodporaAPI dokumentace

mailkit.report.message

Funkce mailkit.report.message poskytne reporty o konkretní rozesílce kampaně.

Ukázka API volání:

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"
   }
}

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
ID_send * = ID rozesílky

* povinný parametr

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

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>Předmět kampaně</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>rrrr-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>Nazev-kampane-20181012</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

JSON

{
  "SEND_COUNT": "2",
  "SUBJECT": "Předmět kampaně",
  "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": "RRRR-MM-DD HH:MM:SS",
  "CLICK_COUNT_U": "1"
  "UTM": "Nazev-kampane-20181012"
}

Hodnoty

SEND_DATE = datum odeslání
SUBJECT = předmět kampaně
SEND_COUNT = odesláno
DELIVERED_COUNT = doručeno
FAILED_COUNT = vráceno
READ_COUNT = čtení
READ_COUNT_U = otevření
CLICK_COUNT = kliknutí
CLICK_COUNT_U = návštěvy
CONVERSION_COUNT = konverze
CONVERSION_COUNT_U = unikátní konverze
MINIPAGE_CLICK_COUNT = kliknutí na microsite
UTM = Název kampaně v UTM rozesílky