List events

curl --request POST \
  --url https://{domain}/api/v2/network/reports/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rangeFrom": "2025-01-01",
  "rangeTo": "2025-01-31",
  "page": 1,
  "perPage": 25,
  "sortField": "added_timestamp",
  "sortDirection": "desc",
  "columns": "transaction_id,event_type,sale_amount,affiliate,offer,currency",
  "filters": {
    "event_types": "dep,wdr",
    "affiliates": "1,2"
  }
}
'

import requests

url = "https://{domain}/api/v2/network/reports/events"

payload = {
    "rangeFrom": "2025-01-01",
    "rangeTo": "2025-01-31",
    "page": 1,
    "perPage": 25,
    "sortField": "added_timestamp",
    "sortDirection": "desc",
    "columns": "transaction_id,event_type,sale_amount,affiliate,offer,currency",
    "filters": {
        "event_types": "dep,wdr",
        "affiliates": "1,2"
    }
}
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({
    rangeFrom: '2025-01-01',
    rangeTo: '2025-01-31',
    page: 1,
    perPage: 25,
    sortField: 'added_timestamp',
    sortDirection: 'desc',
    columns: 'transaction_id,event_type,sale_amount,affiliate,offer,currency',
    filters: {event_types: 'dep,wdr', affiliates: '1,2'}
  })
};

fetch('https://{domain}/api/v2/network/reports/events', 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/reports/events",
  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([
    'rangeFrom' => '2025-01-01',
    'rangeTo' => '2025-01-31',
    'page' => 1,
    'perPage' => 25,
    'sortField' => 'added_timestamp',
    'sortDirection' => 'desc',
    'columns' => 'transaction_id,event_type,sale_amount,affiliate,offer,currency',
    'filters' => [
        'event_types' => 'dep,wdr',
        'affiliates' => '1,2'
    ]
  ]),
  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/reports/events"

	payload := strings.NewReader("{\n  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\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/reports/events")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/reports/events")

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  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Events List",
  "info": [
    {
      "transaction_id": "<string>",
      "click_id": "<string>",
      "created_at": 123,
      "event_type": {
        "id": "<string>",
        "key": "<string>",
        "title": "<string>",
        "qty": 123
      },
      "sale_amount": 123,
      "currency": "USD",
      "affiliate": {
        "id": 123,
        "value": "<string>"
      },
      "advertiser": {
        "id": 123,
        "value": "<string>"
      },
      "offer": {
        "id": 123,
        "value": "<string>"
      },
      "commission_plan": {
        "id": 123,
        "value": "<string>"
      },
      "landing_page": {
        "id": 123,
        "value": "<string>"
      },
      "creative": {
        "id": 123,
        "value": "<string>"
      },
      "smartlink": {
        "id": 123,
        "value": "<string>"
      },
      "campaign": {
        "id": 123,
        "value": "<string>",
        "hash": "<string>"
      },
      "product": "<string>",
      "track_id": "<string>",
      "aff_click_id": "<string>",
      "advertiser_order_id": "<string>",
      "user_id": "<string>",
      "deep_link": "<string>",
      "referer_url": "<string>",
      "aff_sub_id1": "<string>",
      "aff_sub_id2": "<string>",
      "aff_sub_id3": "<string>",
      "aff_sub_id4": "<string>",
      "aff_sub_id5": "<string>",
      "aff_param1": "<string>",
      "aff_param2": "<string>",
      "aff_param3": "<string>",
      "aff_param4": "<string>",
      "aff_param5": "<string>",
      "adv_param1": "<string>",
      "adv_param2": "<string>",
      "adv_param3": "<string>",
      "adv_param4": "<string>",
      "adv_param5": "<string>",
      "ip": "<string>",
      "geo": "<string>",
      "device_type": {
        "id": 123,
        "value": "<string>"
      },
      "device_brand": "<string>",
      "device_model": "<string>",
      "device_os": "<string>",
      "device_os_version": 123,
      "browser": "<string>",
      "browser_version": "<string>",
      "language": "<string>",
      "connection_type": "<string>",
      "mobile_operator": "<string>",
      "risk": 123,
      "traffic_source": {
        "id": 123,
        "value": "<string>"
      },
      "traffic_approach": {
        "id": 123,
        "value": "<string>"
      },
      "custom1": "<string>",
      "custom2": "<string>",
      "custom3": "<string>",
      "custom4": "<string>",
      "custom5": "<string>",
      "custom6": "<string>",
      "custom7": "<string>",
      "custom8": "<string>",
      "custom9": "<string>",
      "custom10": "<string>",
      "suspicious": null,
      "anti_fraud_logic_scope": null,
      "frozen": true,
      "insights": {
        "country": "US / California / San Francisco",
        "device": {
          "type": "<string>",
          "value": "<string>"
        },
        "os": {
          "type": 123,
          "value": "<string>",
          "version": "<string>"
        },
        "suspicious": {
          "value": "<unknown>"
        }
      }
    }
  ]
}

{
  "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": {}
  }
}

Events

List events

Returns a paginated list of raw events (registrations, deposits, withdrawals, bets, wins, FTDs, trades, and other industry-specific event types).

All parameters are sent as a JSON body (Content-Type: application/json).

Date range is required. Both rangeFrom and rangeTo must be present.

Columns selection: use the columns field to specify which fields to return as a comma-separated list. The currency field is always appended automatically. When insights is included, device_type, device_os, and device_os_version are also appended automatically.

Filtering: two independent filter mechanisms are available:

filters (object) — named shorthand filters for common dimensions (affiliates, offers, event types, geo, devices, etc.)
filter (object) — structured condition filter using operators (=, !=, >, >=, <, <=, IN, NOT IN, LIKE, AND, OR, NOT, empty)

Pagination metadata is returned in response headers (X-Pagination-*).

POST

api

network

reports

events

List events

curl --request POST \
  --url https://{domain}/api/v2/network/reports/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rangeFrom": "2025-01-01",
  "rangeTo": "2025-01-31",
  "page": 1,
  "perPage": 25,
  "sortField": "added_timestamp",
  "sortDirection": "desc",
  "columns": "transaction_id,event_type,sale_amount,affiliate,offer,currency",
  "filters": {
    "event_types": "dep,wdr",
    "affiliates": "1,2"
  }
}
'

import requests

url = "https://{domain}/api/v2/network/reports/events"

payload = {
    "rangeFrom": "2025-01-01",
    "rangeTo": "2025-01-31",
    "page": 1,
    "perPage": 25,
    "sortField": "added_timestamp",
    "sortDirection": "desc",
    "columns": "transaction_id,event_type,sale_amount,affiliate,offer,currency",
    "filters": {
        "event_types": "dep,wdr",
        "affiliates": "1,2"
    }
}
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({
    rangeFrom: '2025-01-01',
    rangeTo: '2025-01-31',
    page: 1,
    perPage: 25,
    sortField: 'added_timestamp',
    sortDirection: 'desc',
    columns: 'transaction_id,event_type,sale_amount,affiliate,offer,currency',
    filters: {event_types: 'dep,wdr', affiliates: '1,2'}
  })
};

fetch('https://{domain}/api/v2/network/reports/events', 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/reports/events",
  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([
    'rangeFrom' => '2025-01-01',
    'rangeTo' => '2025-01-31',
    'page' => 1,
    'perPage' => 25,
    'sortField' => 'added_timestamp',
    'sortDirection' => 'desc',
    'columns' => 'transaction_id,event_type,sale_amount,affiliate,offer,currency',
    'filters' => [
        'event_types' => 'dep,wdr',
        'affiliates' => '1,2'
    ]
  ]),
  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/reports/events"

	payload := strings.NewReader("{\n  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\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/reports/events")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/reports/events")

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  \"rangeFrom\": \"2025-01-01\",\n  \"rangeTo\": \"2025-01-31\",\n  \"page\": 1,\n  \"perPage\": 25,\n  \"sortField\": \"added_timestamp\",\n  \"sortDirection\": \"desc\",\n  \"columns\": \"transaction_id,event_type,sale_amount,affiliate,offer,currency\",\n  \"filters\": {\n    \"event_types\": \"dep,wdr\",\n    \"affiliates\": \"1,2\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Events List",
  "info": [
    {
      "transaction_id": "<string>",
      "click_id": "<string>",
      "created_at": 123,
      "event_type": {
        "id": "<string>",
        "key": "<string>",
        "title": "<string>",
        "qty": 123
      },
      "sale_amount": 123,
      "currency": "USD",
      "affiliate": {
        "id": 123,
        "value": "<string>"
      },
      "advertiser": {
        "id": 123,
        "value": "<string>"
      },
      "offer": {
        "id": 123,
        "value": "<string>"
      },
      "commission_plan": {
        "id": 123,
        "value": "<string>"
      },
      "landing_page": {
        "id": 123,
        "value": "<string>"
      },
      "creative": {
        "id": 123,
        "value": "<string>"
      },
      "smartlink": {
        "id": 123,
        "value": "<string>"
      },
      "campaign": {
        "id": 123,
        "value": "<string>",
        "hash": "<string>"
      },
      "product": "<string>",
      "track_id": "<string>",
      "aff_click_id": "<string>",
      "advertiser_order_id": "<string>",
      "user_id": "<string>",
      "deep_link": "<string>",
      "referer_url": "<string>",
      "aff_sub_id1": "<string>",
      "aff_sub_id2": "<string>",
      "aff_sub_id3": "<string>",
      "aff_sub_id4": "<string>",
      "aff_sub_id5": "<string>",
      "aff_param1": "<string>",
      "aff_param2": "<string>",
      "aff_param3": "<string>",
      "aff_param4": "<string>",
      "aff_param5": "<string>",
      "adv_param1": "<string>",
      "adv_param2": "<string>",
      "adv_param3": "<string>",
      "adv_param4": "<string>",
      "adv_param5": "<string>",
      "ip": "<string>",
      "geo": "<string>",
      "device_type": {
        "id": 123,
        "value": "<string>"
      },
      "device_brand": "<string>",
      "device_model": "<string>",
      "device_os": "<string>",
      "device_os_version": 123,
      "browser": "<string>",
      "browser_version": "<string>",
      "language": "<string>",
      "connection_type": "<string>",
      "mobile_operator": "<string>",
      "risk": 123,
      "traffic_source": {
        "id": 123,
        "value": "<string>"
      },
      "traffic_approach": {
        "id": 123,
        "value": "<string>"
      },
      "custom1": "<string>",
      "custom2": "<string>",
      "custom3": "<string>",
      "custom4": "<string>",
      "custom5": "<string>",
      "custom6": "<string>",
      "custom7": "<string>",
      "custom8": "<string>",
      "custom9": "<string>",
      "custom10": "<string>",
      "suspicious": null,
      "anti_fraud_logic_scope": null,
      "frozen": true,
      "insights": {
        "country": "US / California / San Francisco",
        "device": {
          "type": "<string>",
          "value": "<string>"
        },
        "os": {
          "type": 123,
          "value": "<string>",
          "version": "<string>"
        },
        "suspicious": {
          "value": "<unknown>"
        }
      }
    }
  ]
}

{
  "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

rangeFrom

string<date>

required

Start of the date range (inclusive). Format YYYY-MM-DD.

Example:

"2025-01-01"

rangeTo

string<date>

required

End of the date range (inclusive). Format YYYY-MM-DD.

Example:

"2025-01-31"

page

integer

default:1

Page number.

perPage

integer

default:10

Items per page.

sortField

string

default:added_timestamp

Field to sort by. Accepts any valid ClickHouse column name. Common values: added_timestamp, added_date, sale_amount, affiliate_id, offer_id, click_id, transaction_id.

Example:

"added_timestamp"

sortDirection

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

string

Free-text search (minimum 3 characters). Matches across: transaction ID, affiliate ID, offer ID, goal ID, campaign ID, click ID, track ID, order ID, user ID, adv_param1–5, aff_click_id, sub_id1–5, aff_param1–5, IP address. Users with general_see_leads_details permission additionally search custom1–10.

columns

string

Comma-separated list of column names to include in the response. currency is always appended automatically. When insights is present, device_type, device_os, and device_os_version are also appended automatically.

Example:

"transaction_id,event_type,sale_amount,affiliate,offer"

filters

object

Named shorthand filters. Each value is a comma-separated string of IDs (integers) unless noted otherwise.

Show child attributes

filter

object

Structured condition filter (ActiveDataFilter). Supports complex conditions with operators: =, !=, >, >=, <, <=, IN, NOT IN, LIKE, empty, and conjunctions AND, OR, NOT.

Filterable attributes (map key → ClickHouse column): event_ids → transaction_id, clickIds → click_id, event_types → event_type, affiliates → affiliate_id, affiliates_managers, affiliates_tags, aff_click_ids → aff_click_id, affiliates_subids1–5, affiliates_params1–5, clicks_referrers → click_referer, deep_links → deep_link, advertisers → advertiser_id, advertisers_managers, offers → offer_id, offers_categories, offers_tags, offers_goals → goal_id, goals_types → goal_type, currencies → currency, offers_creatives → creative_id, smartlinks → smartlink_id, offers_links → link_id, promo_codes → promo_code, track_ids → track_id, orders_ids → order_id, users_ids → user_id, advertisers_params1–5, conversions_referrers, geo, countries → country_id, devices_types → device_id, devices_brands → brand_id, devices_models → model_id, devices_os → os_id, devices_os_version → os_version, browsers → browser_id, languages → browser_locale_id, connections_types → connection_type_id, mobile_operators → mobile_operator_id, ips → ipv6, commission_plan_ids → commission_plan_id, traffic_source_ids → traffic_source_id, traffic_approach_ids → traffic_approach_id, campaign_ids → campaign_id, is_frozen, clickPeriod → click_timestamp, registrationPeriod → reg_timestamp, ftdPeriod → ftd_timestamp.

Example:

{
  "AND": [
    { "affiliates": { "IN": [1, 2, 3] } },
    { "sale_amount": { ">=": 100 } }
  ]
}

Response

Paginated list of events.

success

boolean

Example:

true

message

string

Example:

"Events List"

info

object[]

Show child attributes

Getting started

Manager

Affiliate

Reference

List events

Authorizations

Body

Response