Mit den neuen Erweiterungen der Evalanche APIs für den Campaign Designer hat man die Möglichkeit vollständige Kampagnen zu erstellen, zu bearbeiten und statistisch auszuwerten. Der Kampagnenzustand läßt sich in Echtzeit abfragen, sowie jeglicher Verlauf der Profile, die eine Kampagne betreten haben.
Ein neues Konfigurationsformat bietet die Möglichkeit alle Einstellungen und Konfigurationen, die der visuelle Campaign Designer bietet, ebenfalls per API abzubilden.
Konfiguration von Kampagnen
Evalanche stellt neue API-Methoden folgender APIs speziell für den Campaign Designer zur Verfügung:
- Konfiguration von Kampagnen werden in der Standard API (SOAP) angeboten
- Statistik und Profilverlauf in der Reporting API
Anlage von Kampagnen
Um Kampagnen über die Standard API (SOAP) anzulegen, steht eine create-Methode zur Verfügung. Diese legt eine neue unkonfigurierte Kampagne mit beliebigem Namen in einem beliebigen Ordner an.
Anlage von Kampagnen per create - Standard API (SOAP)
Ändern von Kampagnen
Folgende Methoden erlauben das auslesen und setzen der Kampagnen-Konfiguration:
Auslesen der Konfiguration per getConfiguration - Standard API (SOAP)
Setzen der Konfiguration per setConfiguration - Standard API (SOAP)
Die eigentliche Konfiguration wird im JSON-Format angenommen und ausgegeben.
Der einfachste Weg eine Kampagnen-Konfiguration im JSON-Format zu erzeugen, ist eine Kampagnen anzulegen, zu konfigurieren und anschließend mit der SOAP-Methode "getConfiguration" auszulesen.
Eine Beispiel-Konfiguration kann z.b.: wie folgt aussehen:
{"configuration-version":"3","nodes":[
{"id":"c2d90a7d-55b5-40b0-90d2-1db7cf0ba39a","type":"targetGroupStart","config":
{"targetGroupId":25328032,"startTime":null,"multipass":
{"enabled":true,"lockDuration":"P0DT0H"}
}
,"connections":
{"true":"99bb7c7a-b6ee-4a4f-a88b-d79d98a9660d"}
,"meta":
{"position":
{"x":142,"y":196}
}
}
,
{"id":"3073cdad-65dd-4e5e-8195-a9155f36f7dd","type":"endPoint","config":
{}
,"meta":
{"position":
{"x":656,"y":196}
}
}
,
{"id":"99bb7c7a-b6ee-4a4f-a88b-d79d98a9660d","type":"delayAction","config":
{"wait":
{"type":"duration","value":"P0DT1H"}
}
,"connections":
{"true":"3073cdad-65dd-4e5e-8195-a9155f36f7dd"}
,"meta":
{"position":
{"x":396,"y":196}
}
}
],"helpers":[]}
Versionierung von Konfigurationen
Jede Änderung der Konfiguration einer Kampagne erzeugt eine neue Version, welche mit der folgenden Methode abgefragt werden kann:
Abfrage der Konfigurationsversion einer Kampagne per getConfigurationVersions - Standard API (SOAP)
Starten und pausieren von Kampagnen
Mit Hilfe der folgenden Methoden können Kampagnen pausiert und erneut gestartet werden, sofern die Konfiguration korrekt ist.
Starten von Kampagnen per activate - Standard API (SOAP)
Stoppen von Kampagnen per deactivate - Standard API (SOAP)
Statistik und Profilverlauf
Die Reporting API bietet eine eigene Tabelle für die Auswertung von Kampagnen-Aktivitäten an. Hiermit lassen die die Verläufe aller Profile einer Kampagne abfragen, auswerten und rekonstruieren.
Aktivitäten von Profilen einer Kampagne campaign-profile-history
Beispiel-URL um den Profilverlauf abzufragen
Die folgenden Informationen werden für den Aufruf benötigt:
customer_id = Die ID des Mandanten, in welchem sich die Kampagne befindet
format = Das Format in dem die Daten ausgegeben werden sollen z.b. "csv"
campaign_id = ID der abzufragenden Kampagne
from = Zeitpunkt ab welchem Daten ausgeliefert werden sollen z.b. "2021-01-01"
to = Zeitpunkt bis zu welchem Daten ausgeliefert werden sollen z.b. "2021-01-01"
In der Tabelle findet sich jeweils ein Eintrag pro Profil und Aktivität. Eine Aktivität beschreibt hierbei immer die Bewegung eines Profils innerhalb einer Kampagne.
Die Tabelle bietet folgende Informationen
|
Spalte |
Typ |
Beschreibung |
|
id |
int |
Eindeutige Id der Aktivität |
|
config_version |
string |
UUID der Konfigurations-Version zum Zeitpunkt der Aktivität |
|
state_id |
string |
UUID des betroffenen Kampagnen-Elements (Knoten) |
|
profile_id |
int |
ID des betroffenen Profils |
|
timestamp |
string |
Zeitpunkt, an welchem das Profil den Knoten verlassen hat |
|
result |
int |
Status der Aktivität (1 = erfolgreich/positiv, 0 = negativ) |