PodporaAPI dokumentace

mailkit.report.message.feedback

Funkce mailkit.report.message.feedback vrací průběh reakcí na konkrétní rozesílku ve zvolené periodě.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message.feedback</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>
    <param>
      <value>
        <string>DAY/WEEK/MONTH</string>
      </value>
    </param>
  </params>
</methodCall>

JSON

{  
   "function":"mailkit.report.message.feedback",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "period":"DAY/WEEK/MONTH",
      "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
DAY/WEEK/MONTH = období dat od okamžiku rozeslání. Výchozí hodnota (DAY)

* povinný parametr

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>2013-12-30 10:00</string>
                  </value>
                </member>
                <member>
                  <name>READ</name>
                  <value>
                    <i4>350</i4>
                  </value>
                </member>
                <member>
                  <name>OPEN</name>
                  <value>
                    <i4>305</i4>
                  </value>
                </member>
                <member>
                  <name>OPEN_P</name>
                  <value>
                    <i4>305</i4>
                  </value>
                </member>
                <member>
                  <name>CLICK</name>
                  <value>
                    <i4>183</i4>
                  </value>
                </member>
                <member>
                  <name>VISIT</name>
                  <value>
                    <i4>112</i4>
                  </value>
                </member>
                <member>
                  <name>VISIT_P</name>
                  <value>
                    <i4>112</i4>
                  </value>
                </member>
                <member>
                  <name>UNSUBSCRIBE</name>
                  <value>
                    <i4>23</i4>
                  </value>
                </member>
                <member>
                  <name>SPAM_REPORT</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[
  {
    "VISIT": 0,
    "OPEN": "44",
    "UNSUBSCRIBE": 0,
    "OPEN_P": "44",
    "DATE": "RRRR-MM-DD",
    "CLICK": 0,
    "SPAM_REPORT": 0,
    "VISIT_P": 0,
    "READ": "58"
  }
]

Hodnoty

DATE = časové období periody (hodina/den)
(např. pro údaj 2013-12-30 10:00 jsou data (po volání DAY nebo WEEK) zobrazována pro hodinu od 2013-12-30 10:00 do 2013-12-30 10:59). V případě použití období MONTH pak DATE bude obsahovat datum dne, pro který jsou vztažena data.
READ = počet čtení
OPEN = počet otevření (unikátní čtení v celém období DAY/WEEK/MONTH)
OPEN_P = počet otevření (unikátních v dané době - hodina/den)
CLICK = počet kliknutí
VISIT = počet návštěv (unikátní kliknutí v celém období DAY/WEEK/MONTH)
VISIT_P = počet návštěv (unikátních v dané době - hodina/den)
UNSUBSCRIBE = počet odhlášení
SPAM_REPORT = počet spam reportů

Tento vzorek ukazuje pouze zkrácenou část odpovědi. Kompletní odpověď by obsahovala data pro celých 24 hodin od rozeslání kampaně. Data jsou obsažena pouze pro hodiny/dny, ve kterých je zaznamenána aktivita. V odbobí DAY/WEEK tedy nebudou u hodin, ve kterých nebyla zaznamenána aktivita (např. noční hodiny), žádné záznamy (ani nulové).