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í:
{
"function": "mailkit.mailinglist.engagement",
"id": "client_id",
"md5": "client_md5",
"parameters": {
"ID_user_list": "12345",
"ID_email": "123456789",
"limit": 100
}
}
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í:
[
{
"TREND": 2,
"SCORE": 5,
"EMAIL": "example@example.eu",
"ID_EMAIL": 123456
}
]
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í:
{
"error": "Invalid ID_user_list",
"error_status": 1
}
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)
