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-*).
Authorizations
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Body
Start of the date range (inclusive). Format YYYY-MM-DD.
"2025-01-01"
End of the date range (inclusive). Format YYYY-MM-DD.
"2025-01-31"
Page number.
Items per page.
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.
"added_timestamp"
Sort direction.
asc, desc 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.
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.
"transaction_id,event_type,sale_amount,affiliate,offer"
Named shorthand filters. Each value is a comma-separated string of IDs (integers) unless noted otherwise.
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.
{
"AND": [
{ "affiliates": { "IN": [1, 2, 3] } },
{ "sale_amount": { ">=": 100 } }
]
}