Tato funkce je určena k přenosu kompletních dat k dalšímu zpracování v externích databázových systémech. Vzhledem k velkému množství dat, prodlevě v reakcích a omezení četnosti dotazů ji NEDOPORUČUJEME používat k běžné integraci, ke které jsou vhodnější rekurzivní funkce mailkit.report.message. Vzhledem k tomu, že funkce vrátí max. 25000 záznamů, je pro kompletní přenos statistik nutné iterovat záznamy uvedením ID_log jako identifikátoru počátečního záznamu.
Ukázka API volání:
JSON
{
"function":"mailkit.report.raw.responses",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_message":"12345",
"ID_send":"12345",
"ID_send_message":"123456798",
"limit":"1234",
"ID_log":"123456789"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.report.raw.responses</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>ID_message</int>
</value>
</param>
<param>
<value>
<int>ID_send</int>
</value>
</param>
<param>
<value>
<int>ID_send_message</int>
</value>
</param>
<param>
<value>
<int>ID_log</int>
</value>
</param>
<param>
<value>
<int>limit</int>
</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_message = ID kampaně
ID_send = ID rozesílky
ID_send_message = ID konkrétní zprávy
ID_log = počáteční ID záznamu, od kterého chcete začít datový výstup
limit = počet záznamů, které chcete přenést (standardně 25000).
* povinný parametr
Po úspěšném volání se vrací:
JSON
[
{
"date": "2001-01-01 01:01:01",
"email": "email@example.com",
"ID_email": "1234567890",
"ID_user_list": "12345",
"ID_message": "12345"
"ID_send": "123456",
"ID_send_message": "1234567890",
"ID_log": "2001011234567980",
"ab_version": "",
"domain": "example.com",
"tld": "com",
"type": "click",
"ID_url": "1234567",
"link_type": "href",
"link_url": "http://www.example.com/about/",
"link_text": "About",
"link_title": "",
"referer": "",
"unsubscribe_answer": "0",
"IP": "123.123.123.0",
"IP_orig": "123.123.123.0",
"continent": "europe",
"country": "Czech Republic",
"code3": "CZE",
"code": "CZ",
"region": "Prazsky",
"region_code": "0",
"city": "Praha",
"user_agent": "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36",
"browser": "Chrome",
"browser_major": "44",
"browser_minor": "0",
"browser_type": "Browser",
"os": "Windows",
"os_version": "8.1",
"device": "Personal computer",
"org": "Sample internet provider",
}
]
XML
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>date</name>
<value>
<string>2001-01-01 01:01:01</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>email@example.com</string>
</value>
</member>
<member>
<name>ID_email</name>
<value>
<i4>1234567890</i4>
</value>
</member>
<member>
<name>ID_user_list</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>ID_message</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>ID_send</name>
<value>
<i4>123456</i4>
</value>
</member>
<member>
<name>ID_send_message</name>
<value>
<i4>1234567890</i4>
</value>
</member>
<member>
<name>ID_log</name>
<value>
<i4>2001011234567890</i4>
</value>
</member>
<member>
<name>ab_version</name>
<value>
<string></string>
</value>
</member>
<member>
<name>domain</name>
<value>
<string>example.com</string>
</value>
</member>
<member>
<name>tld</name>
<value>
<string>com</string>
</value>
</member>
<member>
<name>type</name>
<value>
<string>click</string>
</value>
</member>
<member>
<name>ID_url</name>
<value>
<i4>1234567</i4>
</value>
</member>
<member>
<name>link_type</name>
<value>
<string>href</string>
</value>
</member>
<member>
<name>link_url</name>
<value>
<string>http://www.example.com/about/</string>
</value>
</member>
<member>
<name>link_text</name>
<value>
<string>About</string>
</value>
</member>
<member>
<name>link_title</name>
<value>
<string></string>
</value>
</member>
<member>
<name>referer</name>
<value>
<string></string>
</value>
</member>
<member>
<name>unsubscribe_answer</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>IP</name>
<value>
<string>123.123.123.0</string>
</value>
</member>
<member>
<name>IP_orig</name>
<value>
<string>123.123.123.0</string>
</value>
</member>
<member>
<name>continent</name>
<value>
<string>europe</string>
</value>
</member>
<member>
<name>country</name>
<value>
<string>Czech Republic</string>
</value>
</member>
<member>
<name>code3</name>
<value>
<string>CZE</string>
</value>
</member>
<member>
<name>code</name>
<value>
<string>CZ</string>
</value>
</member>
<member>
<name>region</name>
<value>
<string>Prazsky</string>
</value>
</member>
<member>
<name>region_code</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>Praha</string>
</value>
</member>
<member>
<name>user_agent</name>
<value>
<string>Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36</string>
</value>
</member>
<member>
<name>browser</name>
<value>
<string>Chrome</string>
</value>
</member>
<member>
<name>browser_major</name>
<value>
<string>44</string>
</value>
</member>
<member>
<name>browser_minor</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>browser_type</name>
<value>
<string>Browser</string>
</value>
</member>
<member>
<name>os</name>
<value>
<string>Windows</string>
</value>
</member>
<member>
<name>os_version</name>
<value>
<string>8.1</string>
</value>
</member>
<member>
<name>device</name>
<value>
<string>Personal computer</string>
</value>
</member>
<member>
<name>org</name>
<value>
<string>Sample internet provider</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Hodnoty
date – datum reakce
email – e-mailová adresa příjemce
ID_email – ID e-mailové adresy
ID_user_list – ID seznamu příjemců
ID_message – ID kampaně
ID_send – ID rozesílky
ID_send_message – ID zprávy
ID_log – ID záznamu reakcí pro iteraci
ab_version – varianta zprávy v případě A/B testování
domain – doména adresáta
tld – top-level doména adresáta
type – druh reakce:
- read – čtení zprávy
- botread – čtení zprávy, které bylo vyhodnoceno jako robotické
- click – kliknutí na odkaz ve zprávě
- botclick – kliknutí, které bylo vyhodnoceno jako robotické
- unsubscribe – odhlášení příjmu zpráv
conversion–konverze (starý způsob měření)- spam_report – spam hlášení
- forward – přeposlání zprávy
- print – tisk zprávy
- share – sdílení zprávy
- polls_click – hlasování v anketě
- polls – zobrazení ankety
ID_url – ID url adresy
link_type – druh odkazu (href nebo form)
link_url – URL adresa cílové stránky
link_text – textový název odkazu v e-mailu
link_title – popis odkazu v e-mailu
referer – adresa, skrz kterou návštěva proběhla (dostupné pouze pokud bylo kliknutí přesměrované)
note – způsob odhlášení (pro záznamy s type=unsubscribe):
- oneclick = One-click odhlášení
- unsubscribe.pl = MUA odhlášení
- user.fcgi = příjemce se odhlásil pomocí odhlašovacího linku v zaslané zprávě
- vlastní (jiný) důvod, který příjemce při odhlášení uvedl (viz níže unsubscribe_answer s hodnotou 6)
unsubscribe_answer – důvod odhlášení uvedený příjemcem (pro záznamy s type=unsubscribe) – standardně:
- 0 – bez uvedení důvodu
- 1 – již nechci dostávat tyto zprávy
- 2 – dostávám tyto zprávy příliš často
- 3 – nikdy jsem se nepřihlásil k odběru
- 4 – tyto e-maily jsou nevhodné
- 5 – tyto e-maily jsou spam
- 6 – jiný důvod
IP – IP adresa návštěvníka (poslední oktet je vždy nahrazen 0)
IP_orig – IP adresa návštěvníka (může se lišit od IP, pokud se jedná o interní IP adresu na vnitřní síti nebo za proxy serverem, poslední oktet je vždy nahrazen 0)
continent – kontinent příjemce
country – název země přístupu identifikovaná přes GeoIP
code3 – kód země dle ISO 3166-1 alpha-3
code – kód země dle ISO 3166-2
region – název regionu identifikovaný z GeoIP
region_code – ID regionu v rámci země podle GeoIP
city – město
user_agent – identifikační řetězec prohlížeče příjemce
browser – název prohlížeče z USER_AGENT
browser_major – major verze prohlížeče z USER_AGENT
browser_minor – minor verze prohlížeče z USER_AGENT
browser_type – druh klientského prohlížeče (Browser, Mobile Browser)
os – operační systém z USER_AGENT
os_version – verze operačního systému
device – druh zařízení identifikovaného z USER_AGENT
org – organizace poskytující připojení
V případě, že neexistují žádné reakce příjemců, vrátí API prázdnou odpověď:
JSON
{}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Po neúspěšném volání se vrací:
JSON
{
"error_status": 1,
"error": "Invalid ID_message"
}
XML
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid ID_log format</string>
</value>
</param>
</params>
</methodResponse>
Hodnoty
Invalid ID_message – neplatné ID kampaně
Invalid ID_send – neplatné ID rozesílky
Invalid ID_log format – neplatný formát počátečního záznamu pro iteraci
V ostatních případech vrací API prázdnou odpověď, nebo "Error":
JSON
{
"error_status": 1,
"error": "Error"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
