Die Statistik API wird zum Aufruf der Statistikdaten genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werdenThe statistics API is used to call the statistics data. For this purpose the following parameter must be appended to the API call:
API | Parameterparameter |
|---|---|
Statistikstatistic | get-statistic_{Statistikartstatistictype} |
BeispielExample: https://www.domain.de/api//ACCESS-TOKEN/publisher/ID/get-statistic_daily.csvFür die
Statistik API gibt es die Möglichkeit, die Statistikart zu bestimmen. Dies wird an den API-Aufruf mit angehangen. Eingeleitet wird dies durch “You can specify the type of statistic you need to fetch from the API. This is possible by appending the type on the API call. It starts with "/get-statistic_” gefolgt von dem entsprechenden Parameter. Welche Arten es gibt, wird in folgender Tabelle zusammengefasst:
...
Statistik - Art
...
Parameter
...
" followed by the corresponding parameter. The following table summarizes which types are available:
statistic type | parameter |
|---|---|
statistic per day | get-statistic_daily |
Kampagnen Statistikstatistic per campaign | get-statistic_campaign |
Statistic nach Projectstatistic per project | get-statistic_project |
Statistik nach Subidstatistic per subid | get-statistic_subid |
Statistik nach Trigger statistic per trigger | get-statistic_trigger |
Statistik nach Referrerstatistic per referrer | get-statistic_referrer |
Statistik nach Werbemittelstatistic per admedia | get-statistic_media |
Statistik nach Transaktionenstatistic per transactions | get-statistic_transactions |
Statistik nach Basketsstatistic per baskets | get-orders_baskets |
...
Filters
Die API-Schnittstelle bietet mehrere Filtermöglichkeiten, welche hinter der Statistik mit dem “?” - Operator angehangen werden.
...
Parameter
...
Wert
...
Beschreibung
...
The API interface offers several filter options, which are appended after the statistics with the "?" operator.
parameter | value | description | example | |
|---|---|---|---|---|
condition[period][from] | Startdatum | Definierung des Startdatumsstart date | Definition of the start date. | condition[period][from]=19.12.1909 |
condition[period][to] | Enddatum | Definierung des Enddatumsenddate | Definition of the end date. | condition[period][to]=19.12.1909 |
condition[dynamicdate] | ||||
Aktueller Monat | Alle Daten des aktuellen Monatscurrent month | All data of the current month. | condition[dynamicdate]=currentmonth | |
Vorheriger Monat | Alle Daten des vorherigen Monatsprevious month | All data of the previous month. | condition[dynamicdate]=lastmonth | |
Aktuelle Woche | Alle Daten der aktuellen Wochecurrent week | All data of the current week. | condition[dynamicdate]=currentweek | |
Letzten last [Tagedays] | Es kann hier jeder beliebiger Wert für das Any value for the '[Tagedays]' eingetragen werden (z. B. 10 für die letzen 10 Tagen)can be entered here (e.g. 10 for the last 10 days). | condition[dynamicdate]=last10d | ||
condition[project_id] | Projekt ID | Definition der Projekte, nach denen gefiltert werden sollproject id | Definition of the projects to be filtered. | condition[project_id]=12345 |
condition[bruttodata] | True true / false | Definiert, ob die Zahlen als Bruttozahlen heruntergeladen werden sollen. Dies betrifft vor allem die Klicks und Views der WerbemittelDefines whether the numbers should be downloaded as gross numbers. This concerns especially the clicks and views of the advertising media. | condition[bruttodaten]=true | |
condition[ignormandant] | True true / falseDefiniert | , ob die entsprechenden Daten nur für eine Kampagne heruntergeladen werden sollen oder nichtdefines whever the data should be system-wide or only on the given mandant. | condition[ignoremandant]=true |
Definition der Felder in der Statistik APIDie Spaltennamen der heruntergeladenen Datei beinhalten folgende Parameterof fields in the statistics API
The columns of the downloaded file contain the following parameters:
Feldname | Beschreibung | ||
|---|---|---|---|
criterion | Das Kriterium, welches für die Statistik ausgewählt wurde. Wurde beispielsweise die Statistik nach Tag ausgewählt, werden in diesem Feld die betroffenen Tage ausgegeben. Wird Statistik nach Campagne ausgewählt, werden hier die entsprechenden Kampagnen-ID ausgewählt. In der Regel wird hier die ID ausgegeben. | title | Der Name der entsprechend ausgewählten Criterion. Hier steht z. B. der Name der Kampagne oder des Projekts. The criterion selected for the statistics. For example, if the statistic was selected by day, the days affected are displayed in this field. If statistics by campaign is selected, the corresponding campaign IDs are selected here. Usually the ID is displayed here. |
title | The name of the corresponding selected criterion. For example the name of the campaign or project. | ||
leads_open_count | Anzahl der offenen LeadsNumber of open leads. | ||
leads_confirmed_count | Anzahl der bestätigten LeadsNumber of confirmed leads. | ||
leads_canceled_count | Anzahl der stornierten LeadsNumber of canceled leads. | ||
sales_open_count | Anzahl der offenen SalesNumber of open sales. | ||
sales_confirmed_count | Anzahl der bestätigten SalesNumber of confirmed sales. | ||
sales_canceled_count | Anzahl der stornierten SalesNumber of canceled sales. | ||
all_open_count | Anzahl der offenen Leads und Sales addiertNumber of open leads and sales. | ||
all_confirmed_count | Anzahl der bestätigten Leads und Sales addiertNumber of confirmed leads and sales. | ||
all_canceled_count | Anzahl der stornierten Leads und Sales addiertNumber of canceled leads and sales. | ||
views | Anzahl der ViewsNumber of views. | ||
clicks | Anzahl der KlicksNumber of clicks. | ||
epc | Die berechnete, durchschnittliche Einnahme pro Klick. | ctr | Der Wert gibt an, wie viele User tatsächlich auf das Werbemittel klickten, nachdem sie es gesehen habenThe calculated, average revenue per click. |
ctr | The value indicates how many users actually clicked on the admedia after they saw it. | ||
leads_canceled_turnover | Gesamter Warenkorbwert der stornierten LeadsTotal basket value of the canceled leads. | ||
leads_open_turnover | Gesamter Warenkorbwert der offenen LeadsTotal basket value of the open leads. | ||
leads_confirmed_turnover | Gesamter Warenkorbwert der bestätigten LeadsTotal basket value of the confirmed leads. | ||
sales_canceled_turnover | Gesamter Warenkorbwert stornierten SalesTotal basket value of the canceled sales. | ||
sales_open_turnover | Gesamter Warenkorbwert der offenen SalesTotal basket value of the open sales. | ||
sales_confirmed_turnover | Gesamter Warenkorbwert der bestätigten SalesTotal basket value of the confirmed sales. |