Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Über die API können sämtliche Daten, welche zur Verfügung stehen, heruntergeladen und verarbeitet werden. Die API besteht aus verschiedenen Parametern, die angegeben werden müssen, um Zugriff auf die richtigen Daten zu erhalten.

Mögliche Parameter zur Filterung:

Über die API können auf sämtliche Daten, welche im laufe der Zeit angefallen sind, zugegriffen werden. Über die entsprechenden Parameter wird eine Filterung angewendet, um nur die Daten zu erhalten, welche benötigt werden.

...


General information

All available data can be downloaded and processed via the API. The API consists of various parameters that must be specified to get access to the wanted data.

Possible parameters for filtering:

The API allows access to all data that has been accumulated over time. A filter is applied via the corresponding parameters to obtain only the data that is needed.

Here is an example API-call:

https://www.DOMAIN.decom/api//Access-Token/publisher/ID/get-statistic_daily.csv?condition[period][from]=19.12.1909&condition[period][to]=19.12.1909

Um die API aufzurufen, muss zuerst die Domain des entsprechenden Systems hinterlegt werden. Anschließend folgt “/api//” und der Access-Token des Accounts. Wenn der Access-Token nicht bekannt ist, bitte folgender Anleitung folgenIn order to call the API, the domain of the requested system must first be provided. Afterwards follows "/api//" and the access token of the account. If you don't know the access token, please follow the instructions below:

Wo ist der Access-Token zu finden? Nun wird

nach dem Access-Token ein “/publisher/” angehangen und dann die Publisher ID innerhalb des Systems. Wenn die Publisher ID nicht bekannt ist, bitte folgender Anleitung folgenAfter the access token a "/publisher/" is appended followed by the publisher ID of the system. If the publisher ID is not known, please follow these instructions:

Wo ist die Publisher ID zu finden?

Anschließend wird die Art des API Aufrufs bestimmt. Welche hierbei zur Verfügung stehen kann folgenden Anleitungen entnommen werdenThen the type of API call is determined. Which types of API-calls are available can be found in the following instructions:

Welche API Aufrufe gibt es?

Zum Schluss kann entschieden werden, in welchem Format die Daten bereitgestellt werden sollen. Die Ausgabe der Datei ist Finally, it can be decided in which format the data should be provided. The output of the file is possible in CSV, XLS, XML sowie and JSON möglich. Hierfür muss die Datei-Endung entsprechend angepasst werden. Das CSV Dateiformat wird empfohlen. The file extension must be adapted accordingly. The CSV file format is recommended!

Verfügbare Datenarten

Dateiformatfile format

Parameterparameter

CSV Dateiformat format - Kommagetrenntseperated by comma

.csv

XLS Dateiformat format - Standarddateiformat default format of Microsoft Excel

.xls

XML Dateiformat - Dateiformat Microsoft Excelformat- extensible markup language

.xml

View API

...

Die APIs sind ebenfalls im Frontend zu finden. Dazu muss im eingeloggten Zustand über den Reiter API auf den Punkt Daten-API navigiert werden, wo alle Schnittstellen angeboten werden.

...

Für die Transaktions-API gibt es zusätzliche Parameter, die Abfrage werden können.

...

in frontend

The APIs can also be found in the frontend. In order to do so, you have to login first and afterwards navigating to the tab "API" to the point "Data API", where all interfaces are offered.

...


Transaction – API

For the Transaction API there are additional parameters that can be queried.

Up to this point the following call is known: […]/get-statistic_transactions.csv?[…]

Nachfolgend alle zusätzlichen Parameter, welche abgefragt werden können:

Transaktionsstatus

...

Parameter

...

Wert

...

Beschreibung

...

Below are all additional parameters that can be queried:

Transaction status

parameter

value

description

example

condition[l:processingstate]

openAlle Transaktionen, welche als “Offen” im System hinterlegt sind

All transaction with the status “open” within the system.

condition[I:processingstate]=open

confirmedAlle Transaktionen, welche als “Bestätigt” im System hinterlegt sind

All transaction with the status “confirmed” within the system.

condition[I:processingstate]=confirmed

paidAlle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sind

All transaction with the status “paid” within the system.

condition[I:processingstate]=paid

canceledAlle Transaktionen, welche als “Storniert” im System hinterlegt sind

All transaction with the status “canceled” within the system.

condition[I:processingstate]=canceled

Info: Es ist eine Kombination aus mehreren Status möglich. Zum Beispiel: Please notice: A combination of several statuses is possible. For example:
condition[l:processingstate]=confirmed,paidWeitere Transaktions-API Filter

...

Parameter

...

Wert

...

Beschreibung

...


Additional Transaction API filters

parameter

value

description

example

condition[l:projects]

Zahlenwert, entsprechend des Projekts

Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sindid of the project as integer

All transactions that are stored under the given project ID within the program.

condition[l:projects]=1234

condition[l:campaigns]

Zahlenwert, entsprechend der Kampagne

Alle Transaktionen, welche unter der entsprechenden Kampagne des Programms hinterlegt sindid of the campaign as integer

All transactions that are stored under the given campaign ID within the program.

condition[l:campaigns]=1

condition[timetype]

0 = Erstellungsdatumcreation date

1 = Bearbeitungsdatumprocessing date

2 = AuszahlungsdatumAlle Transaktionen, welche in einem bestimmten Zeitraum erstellt/ generiert/ bearbeitet worden sindpayout date

All transactions that have been created/processed/payed out in a certain period.

condition[timetype]=1

...

 Definition der Felder in der Transaktions-APIDie Spaltennamen der heruntergeladenen Transaktionen beinhalten folgende Parameterof the fields delivered by the transaction api

The columns of downloaded transactions contain the following parameters:

criterionDie verschlüsselte Transaktion-ID

encrypted transaction id

trackingtimeZeitpunkt der Transaktion

timestamp of the transaction

advertiser_idProgramm-Betreiber ID

id of the advertiser within the system

campaign_titleName

des Programms (Kampagne)title of the campaign

campaign_idProgramm ID

id of the campaign within the system

project_idDie

ID Ihrer Webseite (Projekt)id of the project

project_titleTitel

Ihrer Seite (Projekt)title of the project

event

Art der Transaktion – Lead, Sale, Bonus

Payoutdate

Auszahlungsdatum – leer wenn noch nicht beglichen, Formattype of transaction – lead, sale, bonus

payoutdate

Payout date - empty if not payed out yet, format: YYYY-MM-DD HH:MM:SS

processingdate

Bearbeitungszeitpunkt - leer wenn noch nicht bearbeitet, FormatProcessing time - empty if not processed yet, format: YYYY-MM-DD HH:MM:SS

salary_id

Interne Auszahlungs ID - -1 bei noch nicht ausgezahltinternal salary id, -1 if not payed out yet

salary

Gutschriftsnummer – Beleg wie unter Einstellungen=>Gutschriften downloadbar

clicktime

Zeitpunkt des Klicks - FormatCredit note number – document can be downloaded as unter settings =>billing

clicktime

timestamp of the click - format: YYYY-MM-DD HH:MM:SS

subid

Die von Ihnen im Klick / Postview übergebene subid – Falls leer, wird NONE wiedergegeben

referrer

Der Klick-Referrer falls ermittelbar – ansonsten Subid you passed in click / postview - default: NONE

referrer

The click referrer if determinable – default: ://NONE

admedia_idWerbemittel ID des Klicks der zur Transaktion geführt hat

admedia id which led to the transaction

status

0 = offen open |  1 = freigegeben confirmed | 2 = Storniert canceled | 3 = ausgezahltpaid

reason_of_cancellation

Storno-Grund (falls angegebencancel reason (if given)

provisionIhre

Vergütungyour provision

turnoverNetto-Warenkorb Wert

net basked value

trigger_idID des Events

internal id of the event

trigger_titleName

des Eventsname of the event

basket_count

Im Falle von Basket-Tracking wird die Anazhl der im Warenkorb befindlichen Artikel wiedergegeben, sonst in case of basket-tracking, the number of items in the basket, otherwise 0