Eintrags-Api: Eintragsstatistiken

Über einen eigenen Endpunkt können für Einträge auch die wichtigsten Statistiken abgerufen werden. Dabei können die Daten für einzelne Tage zurückgegeben werden oder aggregiert für Kalendermonate. Bei den tagesgenauen Werten werden nur Werte und Tage zurückgegeben, die auch Ereignisse enthalten (um die Datenmengen zu reduzieren).

Aufruf der Eintragsstatistiken

Für die Eintragsstatistiken gibt es einen eigenen Endpunkt. Mit einem GET-Request können Statistiken für einen oder mehrere Einträge angefordert werden. Mehre Einträge macht z. B. dann Sinn, wenn ein Kunde mehrere Einträge verwaltet. Die Schnittstelle ist jedoch nicht daraufhin performancemäßig optimiert, dass sehr viele Einträge und längere Zeiträume über einzelne Requests angefragt werden.

Wenn alle Eintragsstatistiken für einen längeren Zeitraum benötigt werden, würden wir empfehlen, immer nur eine begrenzte Anzahl von Einträgen (z. B. 10 Einträge) pro Request anzufordern und die Requests nacheinander abzuarbeiten, um die Performance des Portals nicht negativ zu beeinträchtigen.

Die Sicherheitsmechanismen und das Securty-Token für diesen Aufruf ist identisch mit der gesamten Eintrags-API und können durch den Portalbetreiber angefragt bzw. verändert werden.

Parameter beim Aufruf

Es gibt folgende Parameter:

  • entryIds: ein oder mehrere kommagetrennte IDs von Einträgen, für die die Statistiken zurückgeliefert werden
  • startDate: Startdatum im Format yyyy-mm-dd (also Jahr-Monat-Tag), nach dem die zurückgegebenen Daten gefiltert werden
  • endDate: Enddatum im Format yyyy-mm-dd (also Jahr-Monat-Tag), nach dem die zurückgegebenen Daten gefiltert werden
  • aggregateMonths: Optionaler Boolscher Parameter, der die Daten jeweils kalender-monatlich aggregiert. Im ersten und letzten Monat werden jedoch nur die Daten ab dem genauen Startdatum bzw. bis zum Enddatum zurückgegeben. Wenn dieser Paramet fehlt oder false ist, dann werden Daten für jeden Tag zurückgeliefert in gesamten Zeitraum.
    Bitte beachten, dass keine Tageswerte für Tage ohne Werte zurückgegeben werden, d.h. Einträge, die beispielsweise gar keine Homepageklicks im ausgewählten Zeitraum hatten, werden nur ein leeres Array [] zurückgeben.

Ein Beispielaufruf könnte dann folgendermaßen aussehen:

http://discoverize-portal.de/api/entries-statistics/v1/?entryIds=41,42&startDate=2024-03-01&endDate=2024-05-31&aggregateMonths=true

Hier würden für die zwei Einträge mit den IDs 41 und 42 alle verfügbaren Statistiken für die Monate März, April und Mai 2024 zurückgegeben.

Format der Statistik-Daten

Die Statistiken der gewünschten Einträge sind in einem Json-Objekt eingebettet. Es gibt dort eine Liste mit potentiellen Fehlern und die eigentlichen Statistikdaten pro Eintrag selbst.

Momentan werden folgende Kategorien von Statistiken unterstützt:

  • PageViewEntryPage (Aufrufe Detailseiten)
  • HomepageLinkClicked (Homepageclicks)
  • PhoneLinkClicked (Anrufe)
  • ShowPhoneClicked ( Telefonnummer angezeigt)
  • InquiryToEntry (Anfragen)
  • FavoritesAddedClicks (Zu Favoriten hinzugefügt)
  • IndividualButtonClicked_Name (Individueller Button Click: Name der Eigenschaft):
    diese Kategorie gibt es nur wenn es auch Eigenschaften vom Typ Individuelle Buttons auf dem Portal gibt. Für jede der vorhandenen Eigenschaften werden hier die entsprechenden Werte zurückgeliefert.

Beispiel-Json:

{
  "Errors":[],
  "EntryStatistics":[
    {
      "EntryId":42,
      "Statistics":[
        {
            "Category":"PageViewEntryPage",
            "CategoryText":"Aufrufe Detailseiten",
            "IntervalType":"Day",
            "Values":[               
                { "StartDate":"2024-03-01", "Value":15},
                { "StartDate":"2024-03-02", "Value":12}            ]
        },
        {
            "Category":"HomepageLinkClicked",
            "CategoryText":"Homepageclicks",
            "IntervalType":"Day",
            "Values":[]
        },
        {
            "Category":"PhoneLinkClicked",
            ...
        },
      ]
    },
    {
      "EntryId":43,
      ...
    }
  ]
}

Die Datumswerte werden für monatliche Aggregationen im Format yyyy-mm (also z. B. 2024-01) zurückgegeben, für Daten für einen Tageszeitraum als Datum im Format yyyy-mm-dd (also z. B. 2024-05-02).

    Unverbindlichen Beratung anfragen

    Gerne besprechen wir in einem Vorgespräch in ca. 15 Minuten Ihre Portalidee und ob und wie sich diese mit discoverize umsetzen ließe. Entweder per Telefon oder gerne auch in Person bei uns im Büro.



    9-12 Uhr12-15 Uhr15-18 Uhr

      Kontakt zum discoverize Team

      Bei allen Fragen rund Branchenportale, Beratung, Strategie helfen wir gerne weiter.