- 16 Jul 2024
- DarkLight
Returns a list of transactions for a given advertiser
- Updated on 16 Jul 2024
- DarkLight
GET transactions (list)
Advertisers can pull individual transactions, check the status of the transactions, create their reports, and obtain additional information that can be shared between publishers and advertisers via clickref (from publisher to advertiser) and orderRef and custom parameters (from advertiser to publisher)
Who can use it
Advertisers
accessToken
advertiser id
access token
date type, if not set - 'transaction' is the default
end date
show basket products
start date
transaction status
time zone in short or default format
Further details on query parameters
parameter | format | mandatory/optional |
startDate | yyyy-MM-ddThh:mm:ss | mandatory |
endDate | yyyy-MM-ddThh:mm:ss | mandatory |
dateType | transaction validation | optional (falls back to "transaction" if not set) |
timezone | Europe/Berlin Europe/Paris Europe/London Europe/Dublin Canada/Eastern Canada/Central Canada/Mountain Canada/Pacific US/Eastern US/Central US/Mountain US/Pacific UTC | mandatory |
publisherId | 12345 or 12345,67890 for multiple ones | optional, available for advertisers |
advertiserId | 12345 or 12345,67890 for multiple ones | optional, available for publishers |
status | pending approved declined deleted | optional |
showBasketProducts | JSON array | optional |
OK
Note that the field "lapseTime" is the conversion time in seconds
Basket Products
If &showBasketProducts=true then products sent via Product Level Tracking matched to the transaction can be viewed (please see "Conditional data fields" below for restrictions that might apply)
Conditional data fields
Some data fields are available for advertisers depending on additional settings.
datafield | available for advertisers |
orderRef | yes |
clickRef | yes |
clickRef2 - clickRef6 | no |
customParameters | yes |
basketProducts | yes |
networkFee | yes, if the advertiser has standard invoicing terms |
Response values for "type"
Sale, Lead, Bonus, 2nd Tier, Commission group transaction, PPC, TQS, Mobile Sale, Mobile Lead, Mobile App Install, Mobile App Purchase, Compensation,