Transaction Report
GET /report/profitloss
Description |
URL |
Response Format |
Request Method |
Authentication |
grab all the stats used within the Transactions report |
https://domain/api/report/transaction |
JSON |
GET |
HTTP headers |
Parameters
Description |
URL |
period |
Which period of time to select data for. See below for more information regarding the periods within Trackfinity. |
start |
start date for the stats. Used when period is not sent or set to 8 |
end |
end date for the stats. Used when period is not sent or set to 8 |
filter_affiliate |
Only see stats for specific affiliate |
filter_loginid |
Only see stats for the specifc login ID passed in. |
filter_campaignid |
Only see stats for the specific campaign ID for the affiliate. (Can only be used if filter_loginid is passed in) |
filter_offerid |
Only see stats for the specific site ID passed in. |
filter_landingpageid |
Only see stats for the specific tour ID passed in. |
filter_adtoolid |
Only see stats for the specific adtool ID passed in. |
filter_programid |
Only see stats for the specific program ID passed in. |
filter_countryid |
Only see stats for the specific Country ID passed in. |
no_inhouse |
0 for all affiliates, 1 to exclude inhouse. |
trans_type |
Type of transactions to return. Default is all. |
filter_external_clickid |
search for a specific affiliate _ocid. |
filter_transaction_hash |
search for an internal click_hash. |
filter_orderid |
search for a transaction with a specific orderid. |
trans_start |
Number of transactions to offset default 0. |
trans_count |
Number of transactions to return default 100. |
Periods
# |
Name |
Argument Description |
0 |
current |
Current Period |
1 |
last |
Last Period |
2 |
today |
Today |
3 |
yesterday |
Yesterday |
4 |
week |
This Week |
5 |
month |
This Month |
6 |
year |
This Year |
7 |
all |
All Time |
8 |
free |
Freeform (See also the start and end parameters above) |
Example Request
php
<?php
$curl = curl_init();
$data = array(
'filter_orderid' => 3890345,
'period' => 7
);
$data_string = http_build_query($data);
$url = 'http://domain/api/report/transaction?'.$data_string;
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
Response:
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)
[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)
)
)
)