Skip to main content
POST
/
api
/
v2
/
network
/
tracking
/
event
Create event (POST)
curl --request POST \
  --url https://{domain}/api/v2/network/tracking/event \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "click_id": "string",
  "type": "dep",
  "amount": 1,
  "currency": "USD"
}
'
import requests

url = "https://{domain}/api/v2/network/tracking/event"

payload = {
"click_id": "string",
"type": "dep",
"amount": 1,
"currency": "USD"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({click_id: 'string', type: 'dep', amount: 1, currency: 'USD'})
};

fetch('https://{domain}/api/v2/network/tracking/event', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/tracking/event",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'click_id' => 'string',
'type' => 'dep',
'amount' => 1,
'currency' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{domain}/api/v2/network/tracking/event"

payload := strings.NewReader("{\n \"click_id\": \"string\",\n \"type\": \"dep\",\n \"amount\": 1,\n \"currency\": \"USD\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/network/tracking/event")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"click_id\": \"string\",\n \"type\": \"dep\",\n \"amount\": 1,\n \"currency\": \"USD\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/tracking/event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"click_id\": \"string\",\n \"type\": \"dep\",\n \"amount\": 1,\n \"currency\": \"USD\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "Event transaction has been added",
  "info": {
    "transaction_id": "<string>"
  }
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
click_id
string
required

Click UUID to attribute the event to.

type
enum<string>
required

Event type code. Values: dep=Deposit, wdr=Withdrawal, bon=Bonus, bet=Bet, win=Win, ftd=First Deposit, reg=Registration, qftd=Qualified FTD, trd=Trade, pft=Profit, bal=Balance, ver=Verification, chb=Chargeback, rak=Rake, adj=Adjustment, ngr=NGR, psf=PSF, ctf=CTF, tax=Tax, bng=Bingo, ggr=GGR, brf=Brf, rev=Revenue, spr=Spread, fdep=Failed Deposit, depatt=Deposit Attempt.

Available options:
dep,
wdr,
bon,
bet,
win,
ftd,
reg,
qftd,
trd,
pft,
bal,
ver,
chb,
rak,
adj,
ngr,
psf,
ctf,
tax,
bng,
ggr,
brf,
rev,
spr,
fdep,
depatt
amount
number

Event monetary value.

currency
string

Currency code (ISO 4217). Defaults to platform currency.

adv_order_id
string

Advertiser order ID.

adv_user_id
string

Advertiser user ID.

adv_track_id
string

Advertiser tracking ID.

adv_param1
string

Custom advertiser parameter 1.

adv_param2
string

Custom advertiser parameter 2.

adv_param3
string

Custom advertiser parameter 3.

adv_param4
string

Custom advertiser parameter 4.

adv_param5
string

Custom advertiser parameter 5.

aff_param1
string

Custom affiliate parameter 1.

aff_param2
string

Custom affiliate parameter 2.

aff_param3
string

Custom affiliate parameter 3.

aff_param4
string

Custom affiliate parameter 4.

aff_param5
string

Custom affiliate parameter 5.

sub_id1
string

Sub-affiliate tracking ID 1.

sub_id2
string

Sub-affiliate tracking ID 2.

sub_id3
string

Sub-affiliate tracking ID 3.

sub_id4
string

Sub-affiliate tracking ID 4.

sub_id5
string

Sub-affiliate tracking ID 5.

promo_code
string

Promo code to associate with the event.

country
string

ISO 3166-1 alpha-2 country code override.

qty
integer

Event quantity (default 1).

event_id
string

External event identifier for deduplication.

product
string

Product key (gaming verticals).

timestamp
string

Event timestamp (UTC). Format: YYYY-MM-DD HH:MM:SS.

Response

Event created.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
Example:

"Event transaction has been added"

info
object