PodporaAPI dokumentace

mailkit.report.message.links

Funkce mailkit.report.message.links vrací report úspěšnosti jednotlivých odkazů konkrétní rozesílky.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message.links</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.links",
   "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>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>URL</name>
                  <value>
                    <string>http://www.sampleurl.site</string>
                  </value>
                </member>
                <member>
                  <name>ID_URL</name>
                  <value>
                    <i4>1234567</i4>
                  </value>
                </member>
                <member>
                  <name>TITLE</name>
                  <value>
                    <string>Lorem ipsum lips</string>
                  </value>
                </member>
                <member>
                  <name>TITLE_SHORT</name>
                  <value>
                    <string>Lorem ipsum</string>
                  </value>
                </member>
                <member>
                  <name>VISIT</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>CLICK</name>
                  <value>
                    <i4>2</i4>
                  </value>
                </member>
                <member>
                  <name>CONVERSION</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>AB_VERSION</name>
                  <value>
                    <i4></i4>
                  </value>
                </member>
                <member>
                  <name>ANCHOR</name>
                  <value>
                    <i4>drinks 2.jpg</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[
  {
    "TITLE": "Lorem ipsum",
    "TITLE_SHORT": "Lorem ipsum lips",
    "ANCHOR": "drinks 2.jpg",
    "URL": "http://www.sampleurl.site/",
    "ID_URL": 123456,
    "AB_VERSION": "",
    "CLICK": 2,
    "VISIT": 1,
    "CONVERSION": 1
  }
]

Hodnoty

URL = cílová url adresa odkazu
ID_URL = ID cílové url adresy
TITLE = název odkazu
TITLE_SHORT = zkrácený název odkazu
VISIT = počet návštěv (unikátní kliknutí)
CLICK = počet kliknutí
CONVERSION = počet konverzí
AB_VERSION = verze kampaně v AB testu
ANCHOR = umístění odkazu (název obrázku, či text, na kterém byl umístěn odkaz)

Tento vzorek ukazuje pouze zkrácenou část odpovědi. Kompletní odpověď by obsahovala data pro všechny odkazy v kampani, které zaznamenaly kliknutí.