Versions Compared

Key

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

Die Transaktions API wird zum Aufruf der Transaktionen genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werdenThe Transaction API is used to retrieve transaction data. For this purpose, the following parameter must be appended to the API call:

API

Parameter

Transaktionen

get-orders

BeispielExample: https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv

Für die Transaktions API gibt es zusätzliche Parameter, die abgefragt werden können. Nachfolgend eine Aufstellung aller Parameter:

Transaktionsstatus

...

Parameter

...

Wert

...

Beschreibung

...

The Transaction API provides access to a range of additional parameters that can be utilized for querying purposes. Below is a comprehensive list of these parameters:

status of transaction

Parameter

Value

Description

Example

condition[l:status]

open

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

All transaction that have the status “open” in the system

condition[I:status]=open

 

confirmed

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

All transaction that have the status “confirmed” in the system

condition[I:status]=confirmed

 

paid

Alle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sind.

All transaction that have the status “paid” in the system

condition[I:status]=paid

 

canceled

Alle Transaktionen, welche als “Storniert” im System hinterlegt sind.

All transaction that have the status “cancelled” in the system

condition[I:status]=canceled

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

additional filter

Parameter

Wert

Value

Beschreibung

Description

Beispiel

Example

condition[l:publisher]

Zahlenwert, entsprechend des Projekts

Alle Transaktionen, welche dem entsprechenden Publisher zugeordnet sind.

Numerical value corresponding to the publisher.

All transactions that have been assigned with the respective publisher

condition[l:publisher]=1001

condition[l:mandant]

Zahlenwert, entsprechend des Mandanten

Alle Transaktionen, welche dem entsprechenden Mandanten zugeordnet sind.Alle Transaktionen, welche dem entsprechenden Advertiser zugeordnet sind.

Numerical value corresponding to the client.

All transactions that have been assigned with the respective client

condition[l:mandant]=1

condition[l:advertiser]

Zahlenwert, entsprechend der Advertiser-ID

Numerical value corresponding to the advertiser id.

All transactions that have been assigned with the respective advertiser

condition[l:advertiser]=1

condition[l:projects]

Zahlenwert, entsprechend des Projekts

Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sind.

Numerical value corresponding to the project.

All transactions that have been assigned with the respective projects

condition[l:projects]=50001

condition[l:campaigns]

Zahlenwert, entsprechend der Kampagne

Alle Transaktionen, welche unter der entsprechenden Kampagne des Programms hinterlegt sind.

Numerical value corresponding to the campaigns.

All transactions that have been assigned with the respective campaigns

condition[l:campaigns]=1

[datemode]

incoming =

Erstellungsdatum

transaction date

processing =

Bearbeitungsdatum

processing date

payout =

AuszahlungsdatumAlle Transaktionen, welche in einem bestimmten Zeitraum erstellt/ bearbeitet/ ausgezahlt worden sind

payout date

All transactions that have been created/processed/paid within a specific time period.

[datemode]=processing

 

Definition der Felder in der Transaktions-API

...

Die Spaltennamen der heruntergeladenen Transaktionen beinhalten folgende Parameter:Definitions of columns names

id

Einzigartige ID der Transaktion.

Unique ID of the transaction

status

Status

der Transaktion.

of the transaction

timestamp

Zeitpunkt der Transaktion.

Transaction date of the transaction

campaign_id

Kampagne, welcher der Transaktion zugeordnet wurde

Campaign ID to which the transaction is assigned.

attribution

Betrag der gezahlten Attribution.

attribution value

delivered_tagcode_count

Anzahl der ausgeführten Tags.

delivered tag codes

delivered_tagcode_serversided_url

Übermittelter Serversided Trackingcall.

delivered serversided tracking call

ordertoken

Vom Advertiser übermittelte Bestellnummer.

order number

source

Quelle der Transaktion.

source of transaction

project_id

Projekt ID, welche die Transaktion zugeordnet wurde

project id to which the transaction is assigned.

admedia_id

Werbemittel-ID über die die Transaktion erzeugt wurde

commission

Provision, welche dem Publisher zugeordnet wurde.

ad media id to which the transaction is assigned.

type

Der Typ der Transaktion wie zum Beispiel Sale oder View.

kind of transaction - e.g sale or lead

commission

commission of transaction

source_commission

commission_group_id

Provisionsgruppe, in der sich der Publisher befand, als Transaktion erzeugt wurde

commission group id in which the project was located when the transaction was generated.

trigger_id

Trigger ID, welche der Transaktion zugeordnet wird.

description

Beschreibung, welche bei der Transaktion übermittelt wurde

trigger id to which the transaction is assigend

description

Additional information that was passed in tracking when the transaction occurred (optional).

trigger_value

Die Vergütung, welche in der entsprechenden Trigger ID zum Zeitpunkt der Transaktion hinterlegt war

The amount of commission, used for calculation the commission.

trigger_type

Art des Triggers (Fixvergütung, prozentuale Vergütung).

turnover

Provisionsrelevanter Bestellwert

type of trigger (e.g fixed commission, percentage commission)

turnover

Revenue of transaction

attributed_turnover

zone_id

zone_name

original_turnover

Bestellwert in der Advertiser-Währung

Revenue in advertiser currency

action_id

Action ID

, welche bei der Transaktion übermittelt wurde.

to which the transaction is assigned

salary_id

ID

des Auszahlungsvorgangs, in welchem die Transaktion abgerechnet wurde

of payout process in whicht the transaction was paid out.

salary_timestamp

session_id

Session ID

, welche bei der Transaktion übermittel wurde.

to which the transaction is assigned

order_currency

Währung der Bestellung.

order currency

status_change_date

Bei späteren Änderungen der Transaktion wird dieser Wert an das entsprechende Datum angepasst.

For transaction status changes, this value is adjusted to the corresponding date

cancel_reason

Wenn die Transaktions storniert wurde, wird hier der Stornogrund hinterlegt.

cancel reason

source_turnover

Vom Advertiser übermittelter Bestellwert.

initial turnover of transaction

last_change

Timestamp der letzten Transaktionsänderung.

timestamp of last transaction modification

user_agent

Clientinformation des Nutzers, welcher die Transaktion erzeugt hat.

User Agent

order_actions_id

Interner Verweis auf den provisionsrelevaten Klick / Postview

internal reference to the commission-relevant click / postview.

bonus_id

Die

Bonus ID

eines Bonus-Laufes.

customer_journey_status

Interne Kennziffer.

internal kpi

ebestid

Gehashte Bestellnummer zur Anzeige für den Publisher.

hashed order number shown in publisher area

order_timestamp

Timestamp des Orderaufrufs.

timestamp of transaction

action_timestamp

Timestamp der Action, welche zur Order führte.

timestamp of click / postview

trigger_title

Name des Trägers.

name of the trigger

payoutdate

Auszahlungsdatum.

payout date

campaign_group_title

Titel der Provisionsgruppe.

title of the commission group

project_title

Name des Projekts, welchem die Transaktion zugeschrieben wurde.

name of the project

campaign_title

Name der Kampagne, die der Transaktion zugeordnet wird.

name of the campaign

advertiser_id

Die ID des Advertisers, welchem die Transaktion zugeordnet wird.

id of the advertiser

advertiser_title

publisher_id

Die ID des Publishers, welchem die Transaktion zu

referrer

Die Seite au der der Klick erzeugt wurde, der später zur Transaktion geführt hat.

country

Land in der die Transaktion erzeugt wurde.

subid

Subid, welche bei der Transaktion übermittel wurde.

publisher_prename

Vorname des Publishers. Wird anhand der Publisher ID aus dem System gezogen.

publisher_surname

Nachname des Publishers. Wird anhand der Publisher ID aus dem System gezogen.

publisher_searchtitle

Suchtitel des Publihsers. Wird anhand der Publisher ID aus dem System gezogen.

basket_items

Anzahl der Artikel im Warenkorb.

sub_status

Advertiser-Interner Status zur Verwaltung der Transaktion.

visibility

Sichtbarkeit für den Publisher.

id of the publisher

referrer

The page where the click was generated that later resulted in the transaction.

country

country the transaction was generated

subid

subid

publisher_prename

prename of the publisher

publisher_surname

surname of the publisher

publisher_searchtitle

searchtitle fhe publisher

publisher_telefone

publisher_dialog_email

basket_items

amount of articles in basket

external_sources_entity_id

external_sources_currency_code

external_sources_currency_rate

external_sources_turnover

source_project_id

source_project_title

order_request_id

turnover_brutto