Dokumentation Backclick 5
Page tree
Skip to end of metadata
Go to start of metadata

Beschreibung

Mit Hilfe dieser Funktion können Sie die Backclick-Statistiken eines Newsletters abrufen.
Als Ergebnis erhalten Sie die gleichen Informationen, die Sie auch über die Administrationsoberfläche unter dem Menüpunkt "Backclick - Statistiken" abrufen können.
Es werden unter anderem die Anzahl der Öffnungen und Klicks dargestellt. Dazu können Sie entweder nach einem speziellen Newsletter suchen, oder Sie geben einen Zeitraum an, zu welchem Sie die Statistiken haben wollen,
Backclick sucht dann die passenden Newsletter dazu heraus und liefert dazu die entsprechenden Statistiken.
Wenn Sie die Statistiken zu einem Zeitraum abrufen möchten, dann darf das Array für die ID's der Newsletter nicht initialisiert werden!

Verfügbar ab Backclick-Version: 5.7.5

Um die Statistiken abzurufen, müssen Sie die folgenden Angaben machen:

  • ID des Mandanten
  • API-Key (optionale Authentifizierung, wenn nicht angegeben, dann wird die Authentifizierung über die IP-Adressen vorgenommen)
  • Newsletter, zu denen die Statistiken abgerufen werden sollen (dabei müssen Sie entweder eine Liste mit den ID's der Newsletter angeben, oder den Zeitraum, zu dem Sie die Statistik benötigen)
    • Liste mit ID's der Newsletter
    • Zeitraumangabe
      • ID der Verteilerliste, auf der gesucht werden soll
      • Zeitraum, in dem gesucht werden soll (jeweils vom Typ "xs:dateTime" z.B. 2017-10-23T20:29:00)

Als Ergebnis erhalten Sie ein strukturiertes Objekt mit allen Informationen.

Wenn Sie die Funktion aufrufen können bei Requests folgende Fehlermeldungen auftreten:

        Error getting Newsletter-List-ID => Die angegebene Verteilerliste existiert nicht


Beispiel

Beispiel für den Abruf über die ID eines Newsletters
$client = new SoapClient($wsdlUrl);
$backclickStatisticRequest = new StdClass();
$backclickStatisticRequest->mandatorId = 0;
$backclickStatisticRequest->newsletterIds = array(1);
try {
  $result = $client->BackclickStatistic($backclickStatisticRequest);
  var_dump($result);
} catch (Exception $e) {
  echo "Fehler aufgetreten: " . $e->getMessage() . "\r\n";
}
Beispielausgabe
object(stdClass)#3 (1) {
  ["backclickStatistic"]=>
  object(stdClass)#4 (22) {
    ["sendedByInternalMta"]=>
    bool(true)
    ["usedConversionTracking"]=>
    bool(true)
    ["abTest"]=>
    bool(false)
    ["newsletterListName"]=>
    string(15) "Testverteiler 1"
    ["newsletterSubject"]=>
    string(22) "Newslettertest"
    ["newsletterDescription"]=>
    string(22) "Newslettertest"
    ["newsletterId"]=>
    int(1)
    ["newsletterListId"]=>
    int(1)
    ["sendStartTime"]=>
    string(29) "2012-10-29T11:13:00.000+01:00"
    ["numRecipientsUnadjusted"]=>
    int(6)
    ["numRecipientsAdjusted"]=>
    int(3)
    ["numSend"]=>
    int(0)
    ["numDelivered"]=>
    int(3)
    ["numLinksClicked"]=>
    int(0)
    ["numOpened"]=>
    int(0)
    ["numUniqueOpened"]=>
    int(0)
    ["numBackclicks"]=>
    int(0)
    ["numUniqueBackclicks"]=>
    int(0)
    ["numActiveSuscribers"]=>
    int(0)
    ["numConversionTracking"]=>
    int(0)
    ["numGeneratedComplaints"]=>
    int(0)
    ["summaryCount"]=>
    int(1)
  }
}
Beispiel für die Abfrage über einen Zeitraum
$client = new SoapClient($wsdlUrl);
$backclickStatisticRequest = new StdClass();
$backclickStatisticRequest->mandatorId = 0;
$backclickStatisticRequest->newslettersInPeriod = new StdClass();
$backclickStatisticRequest->newslettersInPeriod->newsletterListId = 1;
$backclickStatisticRequest->newslettersInPeriod->timePeriod = new StdClass();
date_default_timezone_set('Europe/Berlin');
$backclickStatisticRequest->newslettersInPeriod->timePeriod->startTime = mktime(13, 10, 0, 10, 30, 2012);
$backclickStatisticRequest->newslettersInPeriod->timePeriod->endTime = mktime(13, 19, 0, 10, 30, 2012);
try {
  $result = $client->BackclickStatistic($backclickStatisticRequest);
  var_dump($result);
} catch (Exception $e) {
  echo "Fehler aufgetreten: " . $e->getMessage() . "\r\n";
}

 Quellcode

Um ein funktionsfähiges Beispiel testen können, steht hier der Quellcode zum Download zur Verfügung.

Beispiel für die Abfrage einer Backclick-Statistik