API reference

Schemas

649 schemas from packages/contracts/openapi.yaml. Money values are 6-decimal strings; ids are ULIDs; timestamps are RFC 3339 UTC.

AccountManagerAssign

Field	Type	Flags
`kind`	enum: `partner`, `advertiser`	required
`field`	enum: `account_manager_id`, `account_executive_id`, `sales_manager_id`
`ids`	array of string
`from_employee_id`	string
`employee_id`	string	nullable

AccountManagerAssigned

Field	Type	Flags	Description
`updated`	integer
`ids`	array of string

AccountManagerList

Field	Type	Flags	Description
`data`	array of object (free-form)
`total`	integer

AccountScope

Field	Type	Flags	Description
`restricted`	boolean
`employee_id`	string
`partners`	integer
`advertisers`	integer
`offers`	integer

Adjustment

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`date`	string (date)
`offer_id`	string
`partner_id`	string
`advertiser_id`	string
`goal_id`	string
`clicks`	integer
`conversions`	integer
`payout`	string		decimal string
`revenue`	string		decimal string
`sale_amount`	string		decimal string
`currency`	string
`reason`	string
`source`	string
`reverted_at`	string (date-time)

AdminIPAllowlist

admin_ip_allowlist[] (IPs / CIDR ranges), your_ip

Type: object (free-form)

Advertiser

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`company`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `rejected`
`business_unit_id`	string
`account_manager_id`	string
`sales_manager_id`	string
`internal_notes`	string
`tags`	array of string
`contact`	object (free-form)		email, phone, website, address{address1,address2,city,region_code,country_code,zip}, accounting_contact_email, tax_id, vat_number
`default_currency`	string
`reporting_timezone`	string
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`fallback_url`	string
`blocked_partner_ids`	array of string
`platform`	object (free-form)		platform_name, platform_url, platform_username, offer_id_macro, affiliate_id_macro
`security_token`	string	read-only
`postback_whitelist_ips`	array of string
`postback_security_mode`	enum: `none`, `token`, `ip`, `hmac`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`email_attribution_method`	string
`attribution_priority`	enum: `click`, `coupon`
`is_expose_partner_reporting_data`	boolean
`billing`	object (free-form)		mode prepaid\|postpaid, frequency, details, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, credit_limit, auto_pause_on_zero_balance, is_invoice_creation_auto
`signup_ip`	string	read-only
`signup_answers`	object (free-form)
`last_login_at`	string (date-time)	read-only

AdvertiserBillingSummary

currency, mode, owed, balance, credit_limit, available_credit, outstanding{ccy}, overdue{ccy}, overdue_count, open_count, next_due_on, last_payment

Type: object (free-form)

AdvertiserBulkStatusChange

ids[], status, reason, note

Type: object (free-form)

AdvertiserCaps

data[] {cap_id, offer_name, metric, period, limit, value, remaining, pct, resets_at}, summary, timezone

Type: object (free-form)

AdvertiserClickPage

rows[], has_more, next_cursor

Type: object (free-form)

AdvertiserCreate

Field	Type	Flags	Description
`name`	string	required
`company`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `rejected`
`business_unit_id`	string
`account_manager_id`	string
`sales_manager_id`	string
`internal_notes`	string
`tags`	array of string
`contact`	object (free-form)		email, phone, website, address{address1,address2,city,region_code,country_code,zip}, accounting_contact_email, tax_id, vat_number
`default_currency`	string
`reporting_timezone`	string
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`fallback_url`	string
`blocked_partner_ids`	array of string
`platform`	object (free-form)		platform_name, platform_url, platform_username, offer_id_macro, affiliate_id_macro
`postback_whitelist_ips`	array of string
`postback_security_mode`	enum: `none`, `token`, `ip`, `hmac`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`email_attribution_method`	string
`attribution_priority`	enum: `click`, `coupon`
`is_expose_partner_reporting_data`	boolean
`billing`	object (free-form)		mode prepaid\|postpaid, frequency, details, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, credit_limit, auto_pause_on_zero_balance, is_invoice_creation_auto
`signup_answers`	object (free-form)

AdvertiserDisputeList

rows[] of disputes, has_more

Type: object (free-form)

AdvertiserInvoice

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`advertiser_id`	string
`number`	string
`period_from`	string (date)
`period_to`	string (date)
`currency`	string
`subtotal`	string		decimal string
`tax`	string		decimal string
`total`	string		decimal string
`status`	string
`payment_status`	string
`due_on`	string (date)
`lines`	array of object (free-form)
`pdf_ref`	string

AdvertiserInvoiceCreate

Field	Type	Flags
`advertiser_id`	string	required
`period_from`	string (date)	required
`period_to`	string (date)	required
`currency`	string
`net_terms`	integer

AdvertiserInvoiceDetail

invoice with lines[], payments[], paid, outstanding, payment_link, html

Type: object (free-form)

AdvertiserInvoicePatch

status: approved | sent | draft | void

Type: object (free-form)

AdvertiserList

Field	Type	Flags	Description
`data`	array of Advertiser	required
`page`	Page	required

AdvertiserNotificationList

rows[] of notifications; unread, next_cursor, has_more

Type: object (free-form)

AdvertiserOfferDetail

offer fields, goals[] {key, revenue_type, revenue|revenue_percentage}, caps[], creatives[], landing_pages[], tracking_requirements[]

Type: object (free-form)

AdvertiserPaymentList

rows[] of payments, has_more

Type: object (free-form)

AdvertiserPermissions

role, permissions[], matrix{role: permissions[]}, labels, roles[], conversion_actions, exposes_partners

Type: object (free-form)

AdvertiserProfile

company, currency, reporting_timezone, contact{}, billing_details{}, billing_mode, account_manager, can_edit

Type: object (free-form)

AdvertiserSchedule

Type: object (free-form)

AdvertiserScheduleList

rows[] of schedules, has_more

Type: object (free-form)

AdvertiserSecurity

portal_ip_allowlist[], your_ip, users, users_with_mfa, mfa_required_by_network, can_edit

Type: object (free-form)

AdvertiserStatement

from, to, currency, opening_balance, closing_balance, charges, payments, rows[] {date, description, charges, payments, balance}

Type: object (free-form)

AdvertiserStatusChange

Field	Type	Flags
`status`	enum: `approved`, `rejected`, `cancelled`, `pending`	required
`reason`	enum: `valid`, `duplicate`, `fraud`, `returned`, `cancelled_order`, `test`, `not_qualified`, `invalid_data`, `chargeback`, `advertiser_reconciliation`, `other`
`note`	string
`ids`	array of string

AdvertiserStatusResult

mode, results[] {conversion_id, result updated|disputed|already_disputed|unchanged|unknown|error, reason}, counts

Type: object (free-form)

AdvertiserUpdate

Field	Type	Description
`name`	string
`company`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `rejected`
`business_unit_id`	string
`account_manager_id`	string
`sales_manager_id`	string
`internal_notes`	string
`tags`	array of string
`contact`	object (free-form)	email, phone, website, address{address1,address2,city,region_code,country_code,zip}, accounting_contact_email, tax_id, vat_number
`default_currency`	string
`reporting_timezone`	string
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`fallback_url`	string
`blocked_partner_ids`	array of string
`platform`	object (free-form)	platform_name, platform_url, platform_username, offer_id_macro, affiliate_id_macro
`postback_whitelist_ips`	array of string
`postback_security_mode`	enum: `none`, `token`, `ip`, `hmac`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`email_attribution_method`	string
`attribution_priority`	enum: `click`, `coupon`
`is_expose_partner_reporting_data`	boolean
`billing`	object (free-form)	mode prepaid\|postpaid, frequency, details, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, credit_limit, auto_pause_on_zero_balance, is_invoice_creation_auto
`signup_answers`	object (free-form)

AdvertiserWallet

Prepaid wallet: the ledger account advertiser_prepaid:{advertiser}:{ccy} with its settings and state

Field	Type	Flags	Description
`advertiser_id`	string
`advertiser_name`	string
`configured`	boolean
`enabled`	boolean
`currency`	string
`balance`	string		decimal string
`low_balance_threshold`	string		decimal string
`auto_pause`	boolean
`pause_at`	string		decimal string
`state`	enum: `ok`, `low`, `empty`
`spend_7d`	string		decimal string
`spend_30d`	string		decimal string
`days_left`	integer	nullable
`paused_offers`	integer
`other_balances`	array of object (free-form)
`topups`	array of object (free-form)
`paused_offer_ids`	array of string
`account`	string
`ledger`	array of object (free-form)

AdvertiserWalletList

Field	Type	Flags	Description
`data`	array of object (free-form)
`total`	integer

AdvertiserWalletUpdate

Field	Type	Description
`enabled`	boolean
`currency`	string
`low_balance_threshold`	string	decimal string
`auto_pause`	boolean
`pause_at`	string	decimal string

AnomalyList

data[] {kind drop|spike|cr_drop|epc_jump|conversions_without_clicks, dim total|partner|offer|country, id, label, metric clicks|conversions|cr|epc, direction up|down, day, value, baseline, change_pct, score, report {from, to, dimensions, metrics, filters}}, window {from, to, evaluated_days, time_zone}, skipped_dimensions, money_metric (payout|revenue)

Type: object (free-form)

ApiKey

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`principal_type`	string
`principal_id`	string
`name`	string
`key_prefix`	string	read-only
`scopes`	array of string
`ip_allowlist`	array of string
`rate_limit_per_minute`	integer
`expires_at`	string (date-time)
`last_used_at`	string (date-time)	read-only
`status`	string

ApiKeyCreate

Field	Type	Flags
`principal_type`	string
`principal_id`	string
`name`	string	required
`scopes`	array of string	required
`ip_allowlist`	array of string
`rate_limit_per_minute`	integer
`expires_at`	string (date-time)
`status`	string

ApiKeyList

Field	Type	Flags	Description
`data`	array of ApiKey	required
`page`	Page	required

ApiKeyUpdate

Field	Type	Flags	Description
`principal_type`	string
`principal_id`	string
`name`	string
`scopes`	array of string
`ip_allowlist`	array of string
`rate_limit_per_minute`	integer
`expires_at`	string (date-time)
`status`	string

App

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`platform`	enum: `ios`, `android`, `web`
`bundle_id`	string		iOS bundle id / Android package / web origin
`store_id`	string
`store_url`	string
`icon_url`	string
`advertiser_id`	string
`offer_id`	string		default offer installs are attributed under
`status`	enum: `active`, `paused`, `archived`
`currency`	string
`timezone`	string
`sdk_key`	string	read-only	public app token
`s2s_key_prefix`	string	read-only
`sdk_secret_rotated_at`	string (date-time)	read-only
`require_signature`	boolean
`click_window_hours`	integer
`view_window_hours`	integer
`probabilistic_enabled`	boolean
`probabilistic_window_hours`	integer
`probabilistic_ios_att_denied`	boolean
`reattribution_enabled`	boolean
`reattribution_inactivity_days`	integer
`reattribution_window_days`	integer
`reengagement_enabled`	boolean
`reengagement_window_days`	integer
`reinstall_exclusion_days`	integer
`click_injection_guard`	boolean
`uninstall_tracking`	boolean
`uninstall_push_provider`	enum: `fcm`, `apns`, `other`
`validation_rules`	object (free-form)		events{name:{required[],revenue_required,value_min,value_max,currencies[]}}, allow_unknown_events, require_event_id, max_revenue
`san_config`	object (free-form)		networks[{key,name,partner_id,offer_id,priority,enabled}]
`preinstall_config`	object (free-form)		campaigns[{key,partner_id,offer_id}]
`settings`	object (free-form)

AppCreate

Field	Type	Flags	Description
`name`	string	required
`platform`	enum: `ios`, `android`, `web`	required
`bundle_id`	string	required	iOS bundle id / Android package / web origin
`store_id`	string
`store_url`	string
`icon_url`	string
`advertiser_id`	string
`offer_id`	string		default offer installs are attributed under
`status`	enum: `active`, `paused`, `archived`
`currency`	string
`timezone`	string
`require_signature`	boolean
`click_window_hours`	integer
`view_window_hours`	integer
`probabilistic_enabled`	boolean
`probabilistic_window_hours`	integer
`probabilistic_ios_att_denied`	boolean
`reattribution_enabled`	boolean
`reattribution_inactivity_days`	integer
`reattribution_window_days`	integer
`reengagement_enabled`	boolean
`reengagement_window_days`	integer
`reinstall_exclusion_days`	integer
`click_injection_guard`	boolean
`uninstall_tracking`	boolean
`uninstall_push_provider`	enum: `fcm`, `apns`, `other`
`validation_rules`	object (free-form)		events{name:{required[],revenue_required,value_min,value_max,currencies[]}}, allow_unknown_events, require_event_id, max_revenue
`san_config`	object (free-form)		networks[{key,name,partner_id,offer_id,priority,enabled}]
`preinstall_config`	object (free-form)		campaigns[{key,partner_id,offer_id}]
`settings`	object (free-form)

AppList

Field	Type	Flags	Description
`data`	array of App	required
`page`	Page	required

AppPartner

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`app_id`	string
`partner_id`	string
`postback_mode`	enum: `attributed_only`, `send_all`
`send_installs`	boolean
`send_reattributions`	boolean
`events`	array of string
`status`	enum: `active`, `paused`

AppPartnerCreate

Field	Type	Flags
`app_id`	string	required
`partner_id`	string	required
`postback_mode`	enum: `attributed_only`, `send_all`
`send_installs`	boolean
`send_reattributions`	boolean
`events`	array of string
`status`	enum: `active`, `paused`

AppPartnerList

Field	Type	Flags	Description
`data`	array of AppPartner	required
`page`	Page	required

AppPartnerUpdate

Field	Type	Flags	Description
`app_id`	string
`partner_id`	string
`postback_mode`	enum: `attributed_only`, `send_all`
`send_installs`	boolean
`send_reattributions`	boolean
`events`	array of string
`status`	enum: `active`, `paused`

AppSecrets

Field	Type	Description
`id`	string
`sdk_key`	string
`sdk_secret`	string	shown on create / sdk rotation only
`s2s_key`	string	shown on create / s2s rotation only
`previous_secret_valid`	boolean

AppUpdate

Field	Type	Description
`name`	string
`platform`	enum: `ios`, `android`, `web`
`bundle_id`	string	iOS bundle id / Android package / web origin
`store_id`	string
`store_url`	string
`icon_url`	string
`advertiser_id`	string
`offer_id`	string	default offer installs are attributed under
`status`	enum: `active`, `paused`, `archived`
`currency`	string
`timezone`	string
`require_signature`	boolean
`click_window_hours`	integer
`view_window_hours`	integer
`probabilistic_enabled`	boolean
`probabilistic_window_hours`	integer
`probabilistic_ios_att_denied`	boolean
`reattribution_enabled`	boolean
`reattribution_inactivity_days`	integer
`reattribution_window_days`	integer
`reengagement_enabled`	boolean
`reengagement_window_days`	integer
`reinstall_exclusion_days`	integer
`click_injection_guard`	boolean
`uninstall_tracking`	boolean
`uninstall_push_provider`	enum: `fcm`, `apns`, `other`
`validation_rules`	object (free-form)	events{name:{required[],revenue_required,value_min,value_max,currencies[]}}, allow_unknown_events, require_event_id, max_revenue
`san_config`	object (free-form)	networks[{key,name,partner_id,offer_id,priority,enabled}]
`preinstall_config`	object (free-form)	campaigns[{key,partner_id,offer_id}]
`settings`	object (free-form)

AssistantActionCancelled

Field	Type	Flags	Description
`id`	string
`status`	string

AssistantActionList

Field	Type	Flags	Description
`data`	array of object (free-form)

AssistantActionResult

Field	Type	Flags	Description
`id`	string
`status`	string
`result`	object (free-form)
`executed_at`	string (date-time)

AssistantConversation

Field	Type	Flags
`id`	string
`title`	string
`pinned`	boolean
`pinned_at`	string (date-time)	nullable
`created_at`	string (date-time)
`updated_at`	string (date-time)
`message_count`	integer

AssistantConversationDetail

Field	Type	Flags
`id`	string
`title`	string
`pinned`	boolean
`pinned_at`	string (date-time)	nullable
`created_at`	string (date-time)
`updated_at`	string (date-time)
`messages`	array of AssistantMessage

AssistantConversationList

Field	Type	Flags	Description
`data`	array of AssistantConversation
`pin_limit`	integer
`retention_days`	integer

AssistantConversationPatch

Field	Type	Flags	Description
`title`	string
`pinned`	boolean

AssistantMessage

Field	Type	Flags	Description
`id`	string
`role`	enum: `user`, `assistant`
`content`	string
`steps`	array of object (free-form)
`error`	string
`created_at`	string (date-time)

AssistantPrompt

Field	Type	Description
`id`	string	builtin: for built-in prompts
`title`	string
`description`	string
`body`	string
`source`	enum: `builtin`, `workspace`, `personal`
`audience`	enum: `network`, `partner`, `advertiser`
`editable`	boolean
`updated_at`	string (date-time)

AssistantPromptCreate

Field	Type	Flags
`title`	string	required
`body`	string	required
`shared`	boolean
`audience`	enum: `network`, `partner`, `advertiser`

AssistantPromptList

Field	Type	Flags	Description
`data`	array of AssistantPrompt
`can_share`	boolean

AssistantPromptPatch

Field	Type	Flags	Description
`title`	string
`body`	string

Audience

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`entity_type`	enum: `partner`, `advertiser`
`filter`	object (free-form)		statuses[], tier_ids[], countries[], labels[], offer_ids[], activity active\|inactive, active_days

AudienceCreate

Field	Type	Flags	Description
`name`	string	required
`entity_type`	enum: `partner`, `advertiser`
`filter`	object (free-form)		statuses[], tier_ids[], countries[], labels[], offer_ids[], activity active\|inactive, active_days

AudienceList

Field	Type	Flags	Description
`data`	array of Audience	required
`page`	Page	required

AudienceUpdate

Field	Type	Description
`name`	string
`entity_type`	enum: `partner`, `advertiser`
`filter`	object (free-form)	statuses[], tier_ids[], countries[], labels[], offer_ids[], activity active\|inactive, active_days

AudienceUsage

data {audience_id: {messages, banners}}

Type: object (free-form)

AuditEntry

Field	Type	Flags	Description
`id`	string
`ts`	string (date-time)
`actor_type`	string
`actor_id`	string
`actor_label`	string
`action`	string
`resource_type`	string
`resource_id`	string
`before`	object (free-form)
`after`	object (free-form)
`ip`	string
`request_id`	string

AuditEntryList

Field	Type	Flags	Description
`data`	array of AuditEntry
`page`	Page

AutomationRule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`description`	string
`kind`	enum: `rule`, `alert`, `scheduled_action`
`trigger_kind`	enum: `metric_threshold`, `event`, `schedule`, `once`
`trigger`	object (free-form)		metric_threshold: entity, metric, op, value, period, compare_to, denominator_metric, min_denominator, entity_ids \| event: event, filters \| schedule: cron, timezone
`conditions`	array of object (free-form)
`actions`	array of object (free-form)
`cooldown_seconds`	integer
`dry_run`	boolean
`status`	enum: `active`, `paused`, `done`
`run_at`	string (date-time)
`next_run_at`	string (date-time)	read-only
`last_run_at`	string (date-time)	read-only
`last_fired_at`	string (date-time)	read-only
`preset`	string

AutomationRuleCreate

Field	Type	Flags	Description
`name`	string	required
`description`	string
`kind`	enum: `rule`, `alert`, `scheduled_action`
`trigger_kind`	enum: `metric_threshold`, `event`, `schedule`, `once`	required
`trigger`	object (free-form)		metric_threshold: entity, metric, op, value, period, compare_to, denominator_metric, min_denominator, entity_ids \| event: event, filters \| schedule: cron, timezone
`conditions`	array of object (free-form)
`actions`	array of object (free-form)	required
`cooldown_seconds`	integer
`dry_run`	boolean
`status`	enum: `active`, `paused`, `done`
`run_at`	string (date-time)
`preset`	string

AutomationRuleList

Field	Type	Flags	Description
`data`	array of AutomationRule	required
`page`	Page	required

AutomationRuleUpdate

Field	Type	Description
`name`	string
`description`	string
`kind`	enum: `rule`, `alert`, `scheduled_action`
`trigger_kind`	enum: `metric_threshold`, `event`, `schedule`, `once`
`trigger`	object (free-form)	metric_threshold: entity, metric, op, value, period, compare_to, denominator_metric, min_denominator, entity_ids \| event: event, filters \| schedule: cron, timezone
`conditions`	array of object (free-form)
`actions`	array of object (free-form)
`cooldown_seconds`	integer
`dry_run`	boolean
`status`	enum: `active`, `paused`, `done`
`run_at`	string (date-time)
`preset`	string

BannerStats

data {banner_id: {dismissals, last_dismissed_at}}

Type: object (free-form)

BillingSummary

unbilled[], payables[], receivables[], aging[] {currency, side, current, d30, d60, d90, d90p}, monthly[] {month, currency, billed, paid}, runs {awaiting_approval, in_progress, with_failures}

Type: object (free-form)

BulkActionResult

rows[] {id, name, ok, error, changes[] {field, from, to}}, count, failed, applied

Type: object (free-form)

BulkDeleteRequest

ids[] (1-500), dry_run

Type: object (free-form)

BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

BulkPayoutRequest

ids[], payout {field payout_amount|revenue_amount, mode set|percent, value}, dry_run

Type: object (free-form)

BulkPreview

Field	Type	Flags	Description
`affected`	integer
`changes`	array of object (free-form)
`warnings`	array of string
`token`	string

Call

Field	Type	Description
`id`	string
`provider_call_sid`	string
`number_id`	string
`called_e164`	string
`state`	enum: `ringing`, `answered`, `completed`, `failed`, `no_answer`, `busy`
`started_at`	string (date-time)
`answered_at`	string (date-time)
`ended_at`	string (date-time)
`duration_sec`	integer
`recording_url`	string
`click_id`	string
`attribution`	enum: `dni`, `static`, `none`
`offer_id`	string
`partner_id`	string
`caller`	string	first 8 hex chars of the salted caller hash
`qualification`	enum: `pending`, `qualified`, `rejected`, `skipped`
`qualify_reason`	string
`conversion_id`	string
`payout`	string
`revenue`	string
`currency`	string

CallDestination

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`e164`	string
`offer_id`	string
`advertiser_id`	string
`timezone`	string
`business_hours`	object (free-form)		mon..sun -> [[HH:MM,HH:MM]]; empty = always open
`status`	enum: `active`, `paused`

CallDestinationCreate

Field	Type	Flags	Description
`name`	string	required
`e164`	string	required
`offer_id`	string
`advertiser_id`	string
`timezone`	string
`business_hours`	object (free-form)		mon..sun -> [[HH:MM,HH:MM]]; empty = always open
`status`	enum: `active`, `paused`

CallDestinationList

Field	Type	Flags	Description
`data`	array of CallDestination	required
`page`	Page	required

CallDestinationUpdate

Field	Type	Description
`name`	string
`e164`	string
`offer_id`	string
`advertiser_id`	string
`timezone`	string
`business_hours`	object (free-form)	mon..sun -> [[HH:MM,HH:MM]]; empty = always open
`status`	enum: `active`, `paused`

CallList

Field	Type	Flags	Description
`data`	array of Call	required
`page`	Page	required

CallNumber

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`e164`	string
`label`	string
`country`	string
`kind`	enum: `static`, `pool`
`pool_id`	string
`partner_id`	string
`offer_id`	string
`route_id`	string
`provider`	string	read-only
`provider_sid`	string	read-only
`status`	enum: `active`, `released`
`purchase`	boolean

CallNumberCreate

Field	Type	Flags
`e164`	string	required
`label`	string
`country`	string
`kind`	enum: `static`, `pool`
`pool_id`	string
`partner_id`	string
`offer_id`	string
`route_id`	string
`status`	enum: `active`, `released`
`purchase`	boolean

CallNumberList

Field	Type	Flags	Description
`data`	array of CallNumber	required
`page`	Page	required

CallNumberUpdate

Field	Type	Flags	Description
`e164`	string
`label`	string
`country`	string
`kind`	enum: `static`, `pool`
`pool_id`	string
`partner_id`	string
`offer_id`	string
`route_id`	string
`status`	enum: `active`, `released`
`purchase`	boolean

CallPool

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`offer_id`	string
`partner_id`	string
`route_id`	string
`ttl_seconds`	integer
`fallback_e164`	string
`status`	enum: `active`, `paused`
`number_count`	integer	read-only

CallPoolCreate

Field	Type	Flags
`name`	string	required
`offer_id`	string
`partner_id`	string
`route_id`	string
`ttl_seconds`	integer
`fallback_e164`	string
`status`	enum: `active`, `paused`

CallPoolList

Field	Type	Flags	Description
`data`	array of CallPool	required
`page`	Page	required

CallPoolUpdate

Field	Type	Flags	Description
`name`	string
`offer_id`	string
`partner_id`	string
`route_id`	string
`ttl_seconds`	integer
`fallback_e164`	string
`status`	enum: `active`, `paused`

CallRoute

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`offer_id`	string
`strategy`	enum: `round_robin`, `weighted`, `priority`
`fallback_e164`	string
`ivr`	object (free-form)		enabled, prompt, options[{digit,label,destination_id}]
`targets`	array of object (free-form)
`min_duration_sec`	integer
`require_business_hours`	boolean
`repeat_window_hours`	integer
`goal`	string
`payout`	string
`revenue`	string
`currency`	string
`status`	enum: `active`, `paused`

CallRouteCreate

Field	Type	Flags	Description
`name`	string	required
`offer_id`	string
`strategy`	enum: `round_robin`, `weighted`, `priority`
`fallback_e164`	string
`ivr`	object (free-form)		enabled, prompt, options[{digit,label,destination_id}]
`targets`	array of object (free-form)
`min_duration_sec`	integer
`require_business_hours`	boolean
`repeat_window_hours`	integer
`goal`	string
`payout`	string
`revenue`	string
`currency`	string
`status`	enum: `active`, `paused`

CallRouteList

Field	Type	Flags	Description
`data`	array of CallRoute	required
`page`	Page	required

CallRouteUpdate

Field	Type	Description
`name`	string
`offer_id`	string
`strategy`	enum: `round_robin`, `weighted`, `priority`
`fallback_e164`	string
`ivr`	object (free-form)	enabled, prompt, options[{digit,label,destination_id}]
`targets`	array of object (free-form)
`min_duration_sec`	integer
`require_business_hours`	boolean
`repeat_window_hours`	integer
`goal`	string
`payout`	string
`revenue`	string
`currency`	string
`status`	enum: `active`, `paused`

Campaign

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`template_id`	string
`audience_id`	string
`channel`	enum: `email`, `in_app`, `both`
`status`	enum: `draft`, `scheduled`, `sending`, `sent`, `cancelled`	read-only
`scheduled_at`	string (date-time)
`started_at`	string (date-time)
`finished_at`	string (date-time)
`rate_per_min`	integer

CampaignCreate

Field	Type	Flags
`name`	string	required
`template_id`	string	required
`audience_id`	string	required
`channel`	enum: `email`, `in_app`, `both`
`scheduled_at`	string (date-time)
`started_at`	string (date-time)
`finished_at`	string (date-time)
`rate_per_min`	integer

CampaignList

Field	Type	Flags	Description
`data`	array of Campaign	required
`page`	Page	required

CampaignUpdate

Field	Type	Flags	Description
`name`	string
`template_id`	string
`audience_id`	string
`channel`	enum: `email`, `in_app`, `both`
`scheduled_at`	string (date-time)
`started_at`	string (date-time)
`finished_at`	string (date-time)
`rate_per_min`	integer

Cap

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`entity_type`	enum: `offer`, `offer_group`, `advertiser`, `partner`, `smartlink`, `goal`, `landing_page`, `tenant`
`entity_id`	string
`metric`	enum: `conversions`, `approved_conversions`, `pending_conversions`, `clicks`, `unique_clicks`, `gross_clicks`, `impressions`, `payout`, `pending_payout`, `revenue`, `pending_revenue`, `gross_revenue`, ...
`per_minute`	string		decimal string
`hourly`	string		decimal string
`daily`	string		decimal string
`weekly`	string		decimal string
`monthly`	string		decimal string
`lifetime`	string		decimal string
`partner_ids`	array of string
`partner_cap_mode`	enum: `each`, `group`
`is_apply_all_partners`	boolean
`goal_id`	string
`landing_page_ids`	array of string
`geo`	array of string
`visibility`	enum: `public`, `private`
`on_reached`	enum: `redirect_blank`, `fallback_link`, `fail_traffic`, `pause_entity`, `block`, `notify`
`is_soft_cap`	boolean
`timezone`	string
`is_enforce_caps`	boolean
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`status`	string
`name`	string
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`alert_thresholds`	array of integer
`notify_channels`	array of string
`last_reached_at`	string (date-time)	read-only

CapCreate

Field	Type	Flags	Description
`entity_type`	enum: `offer`, `offer_group`, `advertiser`, `partner`, `smartlink`, `goal`, `landing_page`, `tenant`	required
`entity_id`	string	required
`metric`	enum: `conversions`, `approved_conversions`, `pending_conversions`, `clicks`, `unique_clicks`, `gross_clicks`, `impressions`, `payout`, `pending_payout`, `revenue`, `pending_revenue`, `gross_revenue`, ...	required
`per_minute`	string		decimal string
`hourly`	string		decimal string
`daily`	string		decimal string
`weekly`	string		decimal string
`monthly`	string		decimal string
`lifetime`	string		decimal string
`partner_ids`	array of string
`partner_cap_mode`	enum: `each`, `group`
`is_apply_all_partners`	boolean
`goal_id`	string
`landing_page_ids`	array of string
`geo`	array of string
`visibility`	enum: `public`, `private`
`on_reached`	enum: `redirect_blank`, `fallback_link`, `fail_traffic`, `pause_entity`, `block`, `notify`
`is_soft_cap`	boolean
`timezone`	string
`is_enforce_caps`	boolean
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`status`	string
`name`	string
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`alert_thresholds`	array of integer
`notify_channels`	array of string

CapList

Field	Type	Flags	Description
`data`	array of Cap	required
`page`	Page	required

CapReport

Field	Type	Flags	Description
`data`	array of CapUsage
`timezone`	string
`generated_at`	string (date-time)

CapUpdate

Field	Type	Description
`entity_type`	enum: `offer`, `offer_group`, `advertiser`, `partner`, `smartlink`, `goal`, `landing_page`, `tenant`
`entity_id`	string
`metric`	enum: `conversions`, `approved_conversions`, `pending_conversions`, `clicks`, `unique_clicks`, `gross_clicks`, `impressions`, `payout`, `pending_payout`, `revenue`, `pending_revenue`, `gross_revenue`, ...
`per_minute`	string	decimal string
`hourly`	string	decimal string
`daily`	string	decimal string
`weekly`	string	decimal string
`monthly`	string	decimal string
`lifetime`	string	decimal string
`partner_ids`	array of string
`partner_cap_mode`	enum: `each`, `group`
`is_apply_all_partners`	boolean
`goal_id`	string
`landing_page_ids`	array of string
`geo`	array of string
`visibility`	enum: `public`, `private`
`on_reached`	enum: `redirect_blank`, `fallback_link`, `fail_traffic`, `pause_entity`, `block`, `notify`
`is_soft_cap`	boolean
`timezone`	string
`is_enforce_caps`	boolean
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`status`	string
`name`	string
`fail_traffic_target`	object (free-form)	type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`alert_thresholds`	array of integer
`notify_channels`	array of string

CapUsage

Field	Type	Flags	Description
`cap_id`	string
`name`	string
`entity_type`	string
`entity_id`	string
`metric`	string
`period`	string
`bucket`	string
`limit`	number
`value`	number
`pct`	number
`soft`	boolean
`on_reached`	string
`status`	string
`resets_at`	string (date-time)
`ch_value`	number
`drift`	number
`reconciled_at`	string (date-time)
`live`	boolean
`partner_ids`	array of string

CategoryCreate

Field	Type	Flags
`name`	string	required
`parent_id`	string
`status`	string

Field	Type	Flags	Description
`data`	array of Category	required
`page`	Page	required

CategoryUpdate

Field	Type	Flags	Description
`name`	string
`parent_id`	string
`status`	string

Channel

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`status`	enum: `active`, `archived`

ChannelCreate

Field	Type	Flags	Description
`name`	string	required
`status`	enum: `active`, `archived`

ChannelList

Field	Type	Flags	Description
`data`	array of Channel	required
`page`	Page	required

ChannelUpdate

Field	Type	Flags	Description
`name`	string
`status`	enum: `active`, `archived`

CohortResult

Field	Type	Flags	Description
`kind`	string
`days`	array of integer
`columns`	array of object (free-form)
`rows`	array of array of any
`row_keys`	array of string
`totals`	array of any
`curve`	array of object (free-form)
`as_of`	string (date-time)

Conversion

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`conversion_id`	string
`click_id`	string
`impression_id`	string
`txn_id`	string
`order_id`	string
`conversion_type`	enum: `base`, `goal`, `event`, `upsell`, `rebill`, `refund`, `chargeback`, `adjustment`
`goal_id`	string
`goal_key`	string
`offer_id`	string
`partner_id`	string
`advertiser_id`	string
`landing_page_id`	string
`creative_id`	string
`coupon_code`	string
`ts`	string (date-time)
`click_ts`	string (date-time)
`ctit_seconds`	integer
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`status_reason`	string
`status_source`	string
`is_hidden_from_partner`	boolean
`payout`	string		decimal string
`revenue`	string		decimal string
`sale_amount`	string		decimal string
`currency`	string
`fx_rate`	string		decimal string
`profit`	string		decimal string
`adv`	object (free-form)		adv1..adv10
`params`	object (free-form)		sub1..sub15, source, ...
`method`	enum: `postback`, `pixel`, `iframe`, `js`, `sdk`, `s2s`, `coupon`, `manual`, `import`
`attribution`	object (free-form)		model, touch, confidence, is_organic
`ip`	string
`click_ip`	string
`geo`	object (free-form)
`device`	object (free-form)
`user_id`	string
`fraud`	object (free-form)		score, reasons, rule_ids
`is_test`	boolean
`raw_request`	string
`history`	array of object (free-form)

ConversionBulk

Field	Type	Flags	Description
`mode`	enum: `create`, `status_change`, `upload_csv`
`items`	array of ConversionCreate
`status_changes`	array of object
`file_ref`	string
`fire_postback`	string
`fetch_ip_details`	boolean

ConversionCreate

Field	Type	Description
`conversion_id`	string
`click_id`	string
`impression_id`	string
`txn_id`	string
`order_id`	string
`conversion_type`	enum: `base`, `goal`, `event`, `upsell`, `rebill`, `refund`, `chargeback`, `adjustment`
`goal_id`	string
`goal_key`	string
`offer_id`	string
`partner_id`	string
`advertiser_id`	string
`landing_page_id`	string
`creative_id`	string
`coupon_code`	string
`ts`	string (date-time)
`click_ts`	string (date-time)
`ctit_seconds`	integer
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`status_reason`	string
`status_source`	string
`is_hidden_from_partner`	boolean
`payout`	string	decimal string
`revenue`	string	decimal string
`sale_amount`	string	decimal string
`currency`	string
`fx_rate`	string	decimal string
`profit`	string	decimal string
`adv`	object (free-form)	adv1..adv10
`params`	object (free-form)	sub1..sub15, source, ...
`method`	enum: `postback`, `pixel`, `iframe`, `js`, `sdk`, `s2s`, `coupon`, `manual`, `import`
`attribution`	object (free-form)	model, touch, confidence, is_organic
`ip`	string
`click_ip`	string
`geo`	object (free-form)
`device`	object (free-form)
`user_id`	string
`fraud`	object (free-form)	score, reasons, rule_ids
`is_test`	boolean
`raw_request`	string
`history`	array of object (free-form)

ConversionHold

Field	Type	Flags	Description
`conversion_id`	string
`status`	string
`release_at`	string (date-time)
`then_status`	string
`seconds_left`	integer
`result`	string

ConversionHoldList

Field	Type	Flags	Description
`data`	array of object (free-form)
`page`	object (free-form)		page, page_size, total

ConversionHoldSummary

Field	Type	Flags	Description
`scheduled`	integer
`released`	integer
`cancelled`	integer
`failed`	integer
`next_release_at`	string (date-time)

ConversionPatch

Field	Type	Description
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`reason`	string
`payout`	string	decimal string
`revenue`	string	decimal string
`sale_amount`	string	decimal string
`fire_postback`	boolean

ConversionRuleCatalog

Field	Type	Flags	Description
`actions`	array of string
`variables`	array of object (free-form)
`operators`	array of object (free-form)
`hold_then`	array of string
`hold_minutes_max`	integer

CouponCode

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`code`	string
`offer_id`	string
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`type`	enum: `generic`, `exclusive`, `one_time`
`description`	string
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`payout_rules`	array of object (free-form)
`attribution_mode`	enum: `coupon_overrides_click`, `click_overrides_coupon`, `both`
`usage_count`	integer	read-only
`max_uses`	integer
`used_at`	string (date-time)
`batch_id`	string	read-only

CouponCodeCreate

Field	Type	Flags
`code`	string	required
`offer_id`	string	required
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`type`	enum: `generic`, `exclusive`, `one_time`
`description`	string
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`payout_rules`	array of object (free-form)
`attribution_mode`	enum: `coupon_overrides_click`, `click_overrides_coupon`, `both`
`max_uses`	integer
`used_at`	string (date-time)

CouponCodeList

Field	Type	Flags	Description
`data`	array of CouponCode	required
`page`	Page	required

CouponCodeUpdate

Field	Type	Flags	Description
`code`	string
`offer_id`	string
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`type`	enum: `generic`, `exclusive`, `one_time`
`description`	string
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`payout_rules`	array of object (free-form)
`attribution_mode`	enum: `coupon_overrides_click`, `click_overrides_coupon`, `both`
`max_uses`	integer
`used_at`	string (date-time)

Creative

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`offer_ids`	array of string
`name`	string
`type`	enum: `image`, `html`, `thumbnail`, `email`, `archive`, `video`, `text`, `link`, `native`
`status`	string
`is_private`	boolean
`width`	integer
`height`	integer
`file_ref`	string
`resource_url`	string
`html_code`	string
`html_files`	array of object (free-form)
`mime_type`	string
`description`	string
`email`	object (free-form)		from, subject, subject_lines, from_lines
`partner_visibility`	string
`partner_ids`	array of string
`tags`	array of string
`file_name`	string	read-only
`file_size`	integer	read-only
`file_sha256`	string	read-only
`entry_file`	string	read-only

CreativeCreate

Field	Type	Flags	Description
`offer_ids`	array of string
`name`	string	required
`type`	enum: `image`, `html`, `thumbnail`, `email`, `archive`, `video`, `text`, `link`, `native`	required
`status`	string
`is_private`	boolean
`width`	integer
`height`	integer
`file_ref`	string
`resource_url`	string
`html_code`	string
`html_files`	array of object (free-form)
`mime_type`	string
`description`	string
`email`	object (free-form)		from, subject, subject_lines, from_lines
`partner_visibility`	string
`partner_ids`	array of string
`tags`	array of string

CreativeList

Field	Type	Flags	Description
`data`	array of Creative	required
`page`	Page	required

CreativeSet

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`offer_id`	string
`name`	string
`description`	string
`creative_ids`	array of string
`status`	string
`partner_visibility`	string
`partner_ids`	array of string

CreativeSetCreate

Field	Type	Flags
`offer_id`	string	required
`name`	string	required
`description`	string
`creative_ids`	array of string
`status`	string
`partner_visibility`	string
`partner_ids`	array of string

CreativeSetList

Field	Type	Flags	Description
`data`	array of CreativeSet	required
`page`	Page	required

CreativeSetUpdate

Field	Type	Flags	Description
`offer_id`	string
`name`	string
`description`	string
`creative_ids`	array of string
`status`	string
`partner_visibility`	string
`partner_ids`	array of string

CreativeUpdate

Field	Type	Description
`offer_ids`	array of string
`name`	string
`type`	enum: `image`, `html`, `thumbnail`, `email`, `archive`, `video`, `text`, `link`, `native`
`status`	string
`is_private`	boolean
`width`	integer
`height`	integer
`file_ref`	string
`resource_url`	string
`html_code`	string
`html_files`	array of object (free-form)
`mime_type`	string
`description`	string
`email`	object (free-form)	from, subject, subject_lines, from_lines
`partner_visibility`	string
`partner_ids`	array of string
`tags`	array of string

CustomFieldDefinition

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`entity`	enum: `offer`, `partner`, `advertiser`, `conversion`
`key`	string
`label`	string
`type`	string
`options`	array of object (free-form)
`required`	boolean
`visibility`	string
`position`	integer

CustomFieldDefinitionCreate

Field	Type	Flags
`entity`	enum: `offer`, `partner`, `advertiser`, `conversion`	required
`key`	string	required
`label`	string	required
`type`	string
`options`	array of object (free-form)
`required`	boolean
`visibility`	string
`position`	integer

CustomFieldDefinitionList

Field	Type	Flags	Description
`data`	array of CustomFieldDefinition	required
`page`	Page	required

CustomFieldDefinitionUpdate

Field	Type	Flags	Description
`entity`	enum: `offer`, `partner`, `advertiser`, `conversion`
`key`	string
`label`	string
`type`	string
`options`	array of object (free-form)
`required`	boolean
`visibility`	string
`position`	integer

CustomMetric

Field	Type	Flags	Description
`id`	string	read-only
`key`	string	required	cm_<a-z0-9_>; usable in metrics, sort and metric_filters
`label`	string	required
`description`	string
`formula`	string	required	report metrics with + - * / and parentheses, e.g. (revenue - payout) / clicks
`type`	enum: `integer`, `money`, `percent`, `number`
`audience`	array of enum: `network`, `partner`, `advertiser`
`effective_audience`	array of string	read-only
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only

CustomMetricList

Field	Type	Flags	Description
`rows`	array of CustomMetric
`has_more`	boolean

CustomerValueRule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`offer_id`	string
`partner_ids`	array of string
`metric`	enum: `sale_amount`, `revenue`, `ngr`, `conversions`
`period`	enum: `lifetime`, `month`, `quarter`, `year`
`thresholds`	array of object (free-form)
`carry_negative`	boolean
`status`	string
`description`	string

CustomerValueRuleCreate

Field	Type	Flags
`name`	string	required
`offer_id`	string
`partner_ids`	array of string
`metric`	enum: `sale_amount`, `revenue`, `ngr`, `conversions`
`period`	enum: `lifetime`, `month`, `quarter`, `year`
`thresholds`	array of object (free-form)
`carry_negative`	boolean
`status`	string
`description`	string

CustomerValueRuleList

Field	Type	Flags	Description
`data`	array of CustomerValueRule	required
`page`	Page	required

CustomerValueRuleUpdate

Field	Type	Flags	Description
`name`	string
`offer_id`	string
`partner_ids`	array of string
`metric`	enum: `sale_amount`, `revenue`, `ngr`, `conversions`
`period`	enum: `lifetime`, `month`, `quarter`, `year`
`thresholds`	array of object (free-form)
`carry_negative`	boolean
`status`	string
`description`	string

DNSCheckRequest

records[] {type, host, value} (1-10)

Type: object (free-form)

DNSCheckResult

data[] {type, host, found, matches, seen[], error}, checked_at

Type: object (free-form)

DataConnector

Field	Type	Flags	Description
`id`	string	read-only
`kind`	enum: `bigquery`, `snowflake`	required
`name`	string	required
`config`	object (free-form)		bigquery: project, dataset, location, table_prefix \| snowflake: account, user, role, warehouse, database, schema, stage, storage_integration, table_prefix
`credentials`	string		BigQuery: service-account JSON. Snowflake: password or PEM private key. Write-only; sealed at rest.
`has_credentials`	boolean	read-only
`datasets`	array of enum: `clicks`, `conversions`, `events`, `postback_logs`, `postback_in_logs`, `agg_hourly`
`status`	enum: `active`, `paused`
`last_run_at`	string (date-time)	read-only
`last_status`	string	read-only
`last_error`	string	read-only
`loaded_through`	string (date-time)	read-only
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only

DataConnectorList

Field	Type	Flags	Description
`data`	array of DataConnector
`page`	Page

DataConnectorRun

Field	Type	Flags	Description
`id`	string
`connector_id`	string
`kind`	enum: `load`, `test`
`status`	enum: `queued`, `running`, `succeeded`, `failed`
`partitions_loaded`	integer
`rows_loaded`	integer
`detail`	object (free-form)
`error`	string
`requested_by`	string
`created_at`	string (date-time)
`started_at`	string (date-time)
`finished_at`	string (date-time)

DataConnectorRunList

Field	Type	Flags	Description
`data`	array of DataConnectorRun
`page`	Page

DataConnectorTestRequest

Field	Type	Flags	Description
`live`	boolean		also queue a real authentication probe executed by the worker

DataConnectorTestResult

Field	Type	Flags	Description
`report`	object (free-form)		ok, live, checks[{name,ok,detail}]
`run`	DataConnectorRun

DataHealthCheckDetail

Field	Type	Description
`check`	object (free-form)	key, title, repair (auto\|confirm\|none), description, status (ok\|fail\|error\|skipped\|never), compared, discrepancies, repaired, consecutive_failures, last_ok_at, checked_at, window_from, window_to, last_scope, error
`discrepancies`	array of object (free-form)
`results`	array of object (free-form)
`repairs`	array of object (free-form)

DataHealthOverview

Field	Type	Description
`status`	string	ok \| issues \| never
`verified_at`	string (date-time)
`failing`	integer
`checks`	array of object (free-form)
`last_run`	object (free-form)	id, scope (hourly\|daily\|manual), status, window_from, window_to, checks_total, checks_failed, discrepancies, repairs, requested_by, error, started_at, finished_at
`run_pending`	boolean

DataHealthQueued

Field	Type	Flags	Description
`id`	string
`status`	string
`check`	string
`window_from`	string
`window_to`	string

DataHealthRepairList

Field	Type	Flags	Description
`data`	array of object (free-form)

DataHealthRepairRequest

Field	Type	Flags
`check`	string	required
`discrepancies`	array of string
`all`	boolean
`reason`	string

DataHealthRunList

Field	Type	Flags	Description
`data`	array of object (free-form)

DataHealthRunRequest

Field	Type	Flags	Description
`days`	integer

DataHealthSummary

Field	Type	Flags	Description
`status`	string
`verified_at`	string (date-time)
`failing`	integer
`checks`	integer

DataLockerBackfill

Field	Type	Flags	Description
`id`	string
`dataset`	string
`from_ts`	string (date-time)
`to_ts`	string (date-time)
`grain`	string
`status`	enum: `queued`, `running`, `succeeded`, `failed`
`partitions_total`	integer
`partitions_done`	integer
`error`	string
`requested_by`	string
`created_at`	string (date-time)
`started_at`	string (date-time)
`finished_at`	string (date-time)

DataLockerBackfillList

Field	Type	Flags	Description
`data`	array of DataLockerBackfill
`page`	Page

DataLockerBackfillRequest

Field	Type	Flags	Description
`dataset`	enum: `clicks`, `conversions`, `events`, `postback_logs`, `postback_in_logs`, `agg_hourly`	required
`from`	string	required	RFC3339 or YYYY-MM-DD (UTC)
`to`	string	required
`grain`	enum: `hour`, `day`

DataLockerConfig

Field	Type	Flags	Description
`enabled`	boolean
`provider`	enum: `s3`, `gcs`, `minio`
`endpoint`	string		host[:port]; GCS uses storage.googleapis.com (S3 interop, HMAC keys)
`region`	string
`bucket`	string
`prefix`	string		default: tenant id
`use_ssl`	boolean
`path_style`	boolean
`access_key`	string
`secret_key`	string		write-only; sealed at rest
`secret_set`	boolean	read-only
`datasets`	array of enum: `clicks`, `conversions`, `events`, `postback_logs`, `postback_in_logs`, `agg_hourly`
`grains`	object (free-form)		dataset -> hour\|day override
`retention_days`	integer		0 = keep forever
`lag_minutes`	integer
`configured`	boolean	read-only
`last_run_at`	string (date-time)	read-only
`last_error`	string	read-only
`available_datasets`	array of object (free-form)	read-only

DataLockerManifest

Field	Type	Description
`manifest`	object (free-form)	format dtrackier-locker/1: tenant_id, dataset, grain, schema_version, schema_hash, columns[{name,type,since}], files[{key,start,end,rows,bytes,schema_version,content_hash,written_at}], total_rows, total_bytes
`manifest_key`	string
`bucket`	string

DataLockerPartition

Field	Type	Flags	Description
`id`	string
`dataset`	string
`grain`	enum: `hour`, `day`
`partition_start`	string (date-time)
`partition_end`	string (date-time)
`status`	enum: `written`, `failed`, `expired`
`object_key`	string
`row_count`	integer
`size_bytes`	integer
`schema_version`	integer
`schema_hash`	string
`content_hash`	string
`error`	string
`written_at`	string (date-time)

DataLockerPartitionList

Field	Type	Flags	Description
`data`	array of DataLockerPartition
`page`	Page

DaypartingSchedule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`offer_id`	string
`partner_id`	string
`timezone`	string		IANA zone; empty = tenant caps_timezone
`windows`	array of object
`outside_action`	enum: `block`, `fail_traffic`
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`status`	enum: `active`, `paused`

DaypartingScheduleCreate

Field	Type	Flags	Description
`name`	string
`offer_id`	string	required
`partner_id`	string
`timezone`	string		IANA zone; empty = tenant caps_timezone
`windows`	array of object	required
`outside_action`	enum: `block`, `fail_traffic`
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`status`	enum: `active`, `paused`

DaypartingScheduleList

Field	Type	Flags	Description
`data`	array of DaypartingSchedule	required
`page`	Page	required

DaypartingScheduleUpdate

Field	Type	Description
`name`	string
`offer_id`	string
`partner_id`	string
`timezone`	string	IANA zone; empty = tenant caps_timezone
`windows`	array of object
`outside_action`	enum: `block`, `fail_traffic`
`fail_traffic_target`	object (free-form)	type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`status`	enum: `active`, `paused`

Deal

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`url`	string
`offer_id`	string
`partner_ids`	array of string
`partner_mode`	enum: `include`, `exclude`
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`description`	string
`terms`	string
`is_featured`	boolean
`payout_entry_id`	string
`bonus_type`	enum: `percent`, `flat`
`bonus_value`	number

DealCreate

Field	Type	Flags
`name`	string	required
`url`	string
`offer_id`	string
`partner_ids`	array of string
`partner_mode`	enum: `include`, `exclude`
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`description`	string
`terms`	string
`is_featured`	boolean
`payout_entry_id`	string
`bonus_type`	enum: `percent`, `flat`
`bonus_value`	number

DealList

Field	Type	Flags	Description
`data`	array of Deal	required
`page`	Page	required

DealUpdate

Field	Type	Flags	Description
`name`	string
`url`	string
`offer_id`	string
`partner_ids`	array of string
`partner_mode`	enum: `include`, `exclude`
`start_at`	string (date-time)
`end_at`	string (date-time)
`status`	string
`description`	string
`terms`	string
`is_featured`	boolean
`payout_entry_id`	string
`bonus_type`	enum: `percent`, `flat`
`bonus_value`	number

DeliverySearch

Field	Type	Flags	Description
`status`	enum: `success`, `retrying`, `failed`
`event`	string
`response_code`	integer
`from`	string (date-time)
`to`	string (date-time)
`q`	string
`page`	integer
`page_size`	integer

DisputeResolve

Field	Type	Flags	Description
`decision`	enum: `accept`, `reject`	required
`note`	string		required to reject

DomainDns

Field	Type	Flags	Description
`host`	string
`status`	string
`region`	string
`ssl_mode`	string
`ssl_status`	string
`records`	array of object (free-form)

DomainHealth

Field	Type	Description
`domain_id`	string
`host`	string
`status`	string
`status_reason`	string
`ssl_status`	string
`ssl_expires_at`	string (date-time)
`summary`	object (free-form)	samples, uptime_pct, avg_latency_ms
`samples`	array of object (free-form)

EmailLog

data[] {id, source, recipient, subject, ref_id, status, error, at, opened_at, clicked_at}; page {page, page_size, total}

Type: object (free-form)

EmailProvider

Field	Type	Description
`kind`	enum: `smtp`, `ses`, `sendgrid`, `mailgun`
`from_email`	string
`from_name`	string
`domain`	string
`dkim_selector`	string
`config`	object (free-form)	host, port, username, password, region, api_key, domain (secrets are write-only and returned masked)

Employee

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`user_id`	string
`role_id`	string
`business_unit_id`	string
`title`	string
`work_phone`	string
`cell_phone`	string
`instant_messaging`	object (free-form)
`is_account_manager`	boolean
`is_sales_manager`	boolean
`signature`	string
`status`	string

EmployeeCreate

Field	Type	Flags
`user_id`	string	required
`role_id`	string	required
`business_unit_id`	string
`title`	string
`work_phone`	string
`cell_phone`	string
`instant_messaging`	object (free-form)
`is_account_manager`	boolean
`is_sales_manager`	boolean
`signature`	string
`status`	string

EmployeeList

Field	Type	Flags	Description
`data`	array of Employee	required
`page`	Page	required

EmployeeUpdate

Field	Type	Flags	Description
`user_id`	string
`role_id`	string
`business_unit_id`	string
`title`	string
`work_phone`	string
`cell_phone`	string
`instant_messaging`	object (free-form)
`is_account_manager`	boolean
`is_sales_manager`	boolean
`signature`	string
`status`	string

ErasureRequest

Field	Type	Flags	Description
`click_id`	string
`device_id`	string
`ip`	string
`email_hash`	string
`user_id`	string

Error

Field	Type	Flags	Description
`error`	object

Event

Field	Type	Flags	Description
`app_id`	string	required
`event_name`	string	required
`event_id`	string
`ts`	string (date-time)
`device`	object (free-form)	required	idfa, gaid, idfv, android_id, oaid, external_device_id
`session_id`	string
`revenue`	string		decimal string
`currency`	string
`params`	object (free-form)
`partner_params`	object (free-form)
`consent`	object (free-form)		att, tcf, gpp, google_dma{eea,ad_user_data,ad_personalization}, meta_ldu
`ip`	string
`user_agent`	string
`app_version`	string
`sdk_version`	string
`platform`	string
`os_version`	string
`environment`	enum: `production`, `sandbox`

EventBatch

Field	Type	Flags	Description
`events`	array of Event	required
`idempotency_key`	string

ExportRequest

Field	Type	Flags	Description
`query`	ReportQuery
`log`	LogSearchRequest
`format`	enum: `csv`, `tsv`, `xlsx`, `json`, `parquet`
`notify_email`	string
`labels`	boolean

ExportStatus

Field	Type	Flags	Description
`job_id`	string
`status`	enum: `queued`, `running`, `done`, `failed`, `cancelled`
`progress`	integer
`kind`	string
`rows`	integer
`bytes`	integer
`format`	string
`download_url`	string
`expires_at`	string (date-time)
`error`	string
`created_at`	string (date-time)

FirehoseSink

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`kind`	enum: `sqs`, `pubsub`, `kafka`, `memory`
`config`	object (free-form)		sqs: queue_url, region \| pubsub: project, topic \| kafka: brokers, topic
`types`	array of string
`status`	enum: `active`, `paused`, `disabled`
`consecutive_failures`	integer	read-only
`last_error`	string	read-only
`last_published_at`	string (date-time)	read-only

FirehoseSinkCreate

Field	Type	Flags	Description
`name`	string	required
`kind`	enum: `sqs`, `pubsub`, `kafka`, `memory`	required
`config`	object (free-form)		sqs: queue_url, region \| pubsub: project, topic \| kafka: brokers, topic
`types`	array of string
`status`	enum: `active`, `paused`, `disabled`

FirehoseSinkList

Field	Type	Flags	Description
`data`	array of FirehoseSink	required
`page`	Page	required

FirehoseSinkUpdate

Field	Type	Description
`name`	string
`kind`	enum: `sqs`, `pubsub`, `kafka`, `memory`
`config`	object (free-form)	sqs: queue_url, region \| pubsub: project, topic \| kafka: brokers, topic
`types`	array of string
`status`	enum: `active`, `paused`, `disabled`

FraudBulkAction

Field	Type	Flags
`action`	enum: `approve`, `reject`, `scrub`, `release`	required
`ids`	array of string	required
`note`	string

FraudBulkResult

Field	Type	Flags	Description
`data`	array of object (free-form)
`succeeded`	integer
`failed`	integer

FraudCase

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`kind`	enum: `ctit_distribution`, `benford_subid`, `device_cluster`, `ip_cluster`, `partner_risk`, `manual`, `vendor`
`status`	enum: `open`, `investigating`, `resolved`, `dismissed`
`severity`	enum: `low`, `medium`, `high`, `critical`
`score`	integer
`partner_id`	string
`offer_id`	string
`title`	string
`summary`	string
`evidence`	object (free-form)
`finding_count`	integer	read-only
`period_from`	string (date-time)
`period_to`	string (date-time)
`assigned_to`	string
`resolution_note`	string
`resolved_at`	string (date-time)	read-only
`resolved_by`	string	read-only

FraudCaseCreate

Field	Type	Flags
`kind`	enum: `ctit_distribution`, `benford_subid`, `device_cluster`, `ip_cluster`, `partner_risk`, `manual`, `vendor`
`status`	enum: `open`, `investigating`, `resolved`, `dismissed`
`severity`	enum: `low`, `medium`, `high`, `critical`
`score`	integer
`partner_id`	string
`offer_id`	string
`title`	string	required
`summary`	string
`evidence`	object (free-form)
`period_from`	string (date-time)
`period_to`	string (date-time)
`assigned_to`	string
`resolution_note`	string

FraudCaseList

Field	Type	Flags	Description
`data`	array of FraudCase	required
`page`	Page	required

FraudCaseUpdate

Field	Type	Flags	Description
`kind`	enum: `ctit_distribution`, `benford_subid`, `device_cluster`, `ip_cluster`, `partner_risk`, `manual`, `vendor`
`status`	enum: `open`, `investigating`, `resolved`, `dismissed`
`severity`	enum: `low`, `medium`, `high`, `critical`
`score`	integer
`partner_id`	string
`offer_id`	string
`title`	string
`summary`	string
`evidence`	object (free-form)
`period_from`	string (date-time)
`period_to`	string (date-time)
`assigned_to`	string
`resolution_note`	string

FraudClawbackRequest

Field	Type	Flags	Description
`conversion_ids`	array of string	required
`reason`	string

FraudListEntry

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`kind`	enum: `allow`, `deny`
`type`	enum: `ip`, `ip_cidr`, `device`, `email_hash`, `user_id`, `sub_id`, `asn`, `isp`, `referrer_domain`
`value`	string
`reason`	string
`source`	enum: `manual`, `batch`, `vendor`, `import`
`partner_id`	string
`expires_at`	string (date-time)
`entries`	array of object (free-form)

FraudListEntryCreate

Field	Type	Flags
`kind`	enum: `allow`, `deny`	required
`type`	enum: `ip`, `ip_cidr`, `device`, `email_hash`, `user_id`, `sub_id`, `asn`, `isp`, `referrer_domain`	required
`value`	string	required
`reason`	string
`source`	enum: `manual`, `batch`, `vendor`, `import`
`partner_id`	string
`expires_at`	string (date-time)
`entries`	array of object (free-form)

FraudListEntryList

Field	Type	Flags	Description
`data`	array of FraudListEntry	required
`page`	Page	required

FraudListEntryUpdate

Field	Type	Flags	Description
`kind`	enum: `allow`, `deny`
`type`	enum: `ip`, `ip_cidr`, `device`, `email_hash`, `user_id`, `sub_id`, `asn`, `isp`, `referrer_domain`
`value`	string
`reason`	string
`source`	enum: `manual`, `batch`, `vendor`, `import`
`partner_id`	string
`expires_at`	string (date-time)
`entries`	array of object (free-form)

FraudPartnerRisk

Field	Type	Flags	Description
`partner_id`	string
`score`	integer
`grade`	enum: `A`, `B`, `C`, `D`, `F`
`blocked`	boolean
`components`	object (free-form)
`clicks`	integer
`conversions`	integer
`flagged`	integer
`rejected`	integer
`window_days`	integer
`computed_at`	string (date-time)
`queue_30d`	object (free-form)
`top_reasons_30d`	object (free-form)
`open_cases`	integer

FraudQueueItem

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`conversion_id`	string	read-only
`click_id`	string	read-only
`txn_id`	string	read-only
`offer_id`	string	read-only
`partner_id`	string	read-only
`advertiser_id`	string	read-only
`goal_key`	string	read-only
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`status_reason`	string	read-only
`status_source`	string	read-only
`score`	integer	read-only
`band`	enum: `low`, `medium`, `high`, `critical`	read-only
`reasons`	array of string
`rule_ids`	array of string
`explain`	array of object (free-form)
`payout`	string		decimal string
`revenue`	string		decimal string
`currency`	string
`conversion_ts`	string (date-time)
`click_ts`	string (date-time)
`ctit_seconds`	integer
`country`	string
`click_country`	string
`ip`	string
`device_type`	string
`os`	string
`sub1`	string
`source`	string
`user_id`	string
`email_hash`	string
`resolution`	enum: `approved`, `rejected`, `scrubbed`, `released`	read-only
`resolved_by`	string	read-only
`resolved_at`	string (date-time)	read-only
`resolution_note`	string

FraudQueueItemList

Field	Type	Flags	Description
`data`	array of FraudQueueItem	required
`page`	Page	required

FraudResult

Field	Type	Flags	Description
`score`	integer
`band`	string
`action`	string
`reasons`	array of string
`rule_ids`	array of string
`explain`	array of object (free-form)
`pack_id`	string
`dry_run`	boolean
`allow_listed`	boolean

FraudRulePack

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`mode`	enum: `strict`, `balanced`, `lenient`, `custom`
`scope_type`	enum: `tenant`, `offer`, `partner`
`scope_id`	string
`status`	enum: `active`, `paused`, `archived`
`dry_run`	boolean
`priority`	integer
`signal_weights`	object (free-form)		signal code -> weight 0-100 (overrides the mode defaults; see /fraud/rule-packs/presets)
`disabled_signals`	array of string
`click_bands`	array of object (free-form)
`conversion_bands`	array of object (free-form)
`block_partner_score`	integer
`params`	object (free-form)		ctit_min_seconds, flood_window_seconds, flood_max_ip, flood_max_sub, flood_max_partner, device_repeat_max, velocity_window_seconds, velocity_max_partner, duplicate_ip_max, cr_baseline_pct, cr_anomaly_factor, cr_min_clicks, night_start_hour, night_end_hour, uniform_ctit_tolerance, min_uniform_sample, allowed_geos[], min_sdk_version

FraudRulePackCreate

Field	Type	Flags	Description
`name`	string	required
`mode`	enum: `strict`, `balanced`, `lenient`, `custom`
`scope_type`	enum: `tenant`, `offer`, `partner`
`scope_id`	string
`status`	enum: `active`, `paused`, `archived`
`dry_run`	boolean
`priority`	integer
`signal_weights`	object (free-form)		signal code -> weight 0-100 (overrides the mode defaults; see /fraud/rule-packs/presets)
`disabled_signals`	array of string
`click_bands`	array of object (free-form)
`conversion_bands`	array of object (free-form)
`block_partner_score`	integer
`params`	object (free-form)		ctit_min_seconds, flood_window_seconds, flood_max_ip, flood_max_sub, flood_max_partner, device_repeat_max, velocity_window_seconds, velocity_max_partner, duplicate_ip_max, cr_baseline_pct, cr_anomaly_factor, cr_min_clicks, night_start_hour, night_end_hour, uniform_ctit_tolerance, min_uniform_sample, allowed_geos[], min_sdk_version

FraudRulePackList

Field	Type	Flags	Description
`data`	array of FraudRulePack	required
`page`	Page	required

FraudRulePackUpdate

Field	Type	Description
`name`	string
`mode`	enum: `strict`, `balanced`, `lenient`, `custom`
`scope_type`	enum: `tenant`, `offer`, `partner`
`scope_id`	string
`status`	enum: `active`, `paused`, `archived`
`dry_run`	boolean
`priority`	integer
`signal_weights`	object (free-form)	signal code -> weight 0-100 (overrides the mode defaults; see /fraud/rule-packs/presets)
`disabled_signals`	array of string
`click_bands`	array of object (free-form)
`conversion_bands`	array of object (free-form)
`block_partner_score`	integer
`params`	object (free-form)	ctit_min_seconds, flood_window_seconds, flood_max_ip, flood_max_sub, flood_max_partner, device_repeat_max, velocity_window_seconds, velocity_max_partner, duplicate_ip_max, cr_baseline_pct, cr_anomaly_factor, cr_min_clicks, night_start_hour, night_end_hour, uniform_ctit_tolerance, min_uniform_sample, allowed_geos[], min_sdk_version

FraudRunStatus

requested_at, last_run {at, findings, cases, partners, blocked, error}, computed_at

Type: object (free-form)

FraudScoreRequest

Field	Type	Flags	Description
`kind`	enum: `click`, `conversion`	required
`pack_id`	string
`mode`	enum: `strict`, `balanced`, `lenient`
`input`	object (free-form)	required	ClickInput / ConversionInput fields (IP, UA, Country, ClickTS, ...)

FraudVendorConfig

Field	Type	Flags	Description
`vendor`	enum: `ipqs`, `anura`, `24metrics`, `forensiq`, `fake`
`enabled`	boolean
`api_key`	string		sealed at rest; never returned
`has_api_key`	boolean	read-only
`settings`	object (free-form)		base_url, timeout_ms, extra{instance,...}, block_at, flag_at, mode click\|conversion\|both
`last_error`	string	read-only
`last_used_at`	string (date-time)	read-only

FunnelQuery

Field	Type	Flags
`from`	string (date)	required
`to`	string (date)	required
`timezone`	string
`window_hours`	integer
`breakdown`	enum: `offer`, `partner`, `advertiser`, `country`, `device_type`, `os`, `source`, `sub1`
`filters`	array of object (free-form)
`limit`	integer
`steps`	array of object (free-form)	required

FunnelResult

Field	Type	Description
`steps`	array of object (free-form)
`total`	object (free-form)	counts[], rates[] (% of step 1), step_rates[] (% of previous step)
`rows`	array of object (free-form)
`breakdown`	string
`window_hours`	integer

FxRate

Field	Type	Description
`base`	string
`quote`	string
`rate`	string	decimal string
`source`	string
`rate_date`	string (date)

Goal

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`offer_id`	string	read-only
`name`	string
`key`	string
`type`	enum: `public`, `private`, `partner_specific`
`is_base_conversion`	boolean
`partner_ids`	array of string
`event_category`	enum: `install`, `registration`, `lead`, `sale`, `deposit`, `ftd`, `subscription`, `trial`, `purchase`, `level`, `retention`, `custom`
`revenue_semantics`	enum: `fixed`, `from_sale_amount`, `from_param`
`track_multi`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve`	boolean
`is_allow_duplicate`	boolean
`default_status`	enum: `approved`, `pending`, `rejected`, `cancelled`
`blacklist_postback_partners`	array of string
`whitelist_postback_partners`	array of string
`kpi_window_days`	integer
`validation_rules`	array of object (free-form)
`global_advertiser_event_id`	string

GoalCreate

Field	Type	Flags
`name`	string	required
`key`	string	required
`type`	enum: `public`, `private`, `partner_specific`
`is_base_conversion`	boolean
`partner_ids`	array of string
`event_category`	enum: `install`, `registration`, `lead`, `sale`, `deposit`, `ftd`, `subscription`, `trial`, `purchase`, `level`, `retention`, `custom`
`revenue_semantics`	enum: `fixed`, `from_sale_amount`, `from_param`
`track_multi`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve`	boolean
`is_allow_duplicate`	boolean
`default_status`	enum: `approved`, `pending`, `rejected`, `cancelled`
`blacklist_postback_partners`	array of string
`whitelist_postback_partners`	array of string
`kpi_window_days`	integer
`validation_rules`	array of object (free-form)
`global_advertiser_event_id`	string

GoalList

Field	Type	Flags	Description
`data`	array of Goal	required
`page`	Page	required

GoalUpdate

Field	Type	Flags	Description
`name`	string
`key`	string
`type`	enum: `public`, `private`, `partner_specific`
`is_base_conversion`	boolean
`partner_ids`	array of string
`event_category`	enum: `install`, `registration`, `lead`, `sale`, `deposit`, `ftd`, `subscription`, `trial`, `purchase`, `level`, `retention`, `custom`
`revenue_semantics`	enum: `fixed`, `from_sale_amount`, `from_param`
`track_multi`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve`	boolean
`is_allow_duplicate`	boolean
`default_status`	enum: `approved`, `pending`, `rejected`, `cancelled`
`blacklist_postback_partners`	array of string
`whitelist_postback_partners`	array of string
`kpi_window_days`	integer
`validation_rules`	array of object (free-form)
`global_advertiser_event_id`	string

IdList

Field	Type	Flags	Description
`ids`	array of string	required

IgamingBrand

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`advertiser_id`	string
`offer_id`	string
`currency`	string
`ngr_formula`	object (free-form)		admin_fee_pct, tax_pct, deduct_bonuses, deduct_chargebacks, deduct_fees: NGR = GGR - bonuses - admin% x GGR - tax% x GGR - chargebacks - fees
`negative_carryover`	boolean
`blocked_countries`	array of string
`geo_list_id`	string
`require_kyc`	boolean
`s2s_token_prefix`	string	read-only
`status`	enum: `active`, `paused`, `archived`
`description`	string

IgamingBrandCreate

Field	Type	Flags	Description
`name`	string	required
`advertiser_id`	string
`offer_id`	string
`currency`	string
`ngr_formula`	object (free-form)		admin_fee_pct, tax_pct, deduct_bonuses, deduct_chargebacks, deduct_fees: NGR = GGR - bonuses - admin% x GGR - tax% x GGR - chargebacks - fees
`negative_carryover`	boolean
`blocked_countries`	array of string
`geo_list_id`	string
`require_kyc`	boolean
`status`	enum: `active`, `paused`, `archived`
`description`	string

IgamingBrandList

Field	Type	Flags	Description
`data`	array of IgamingBrand	required
`page`	Page	required

IgamingBrandUpdate

Field	Type	Description
`name`	string
`advertiser_id`	string
`offer_id`	string
`currency`	string
`ngr_formula`	object (free-form)	admin_fee_pct, tax_pct, deduct_bonuses, deduct_chargebacks, deduct_fees: NGR = GGR - bonuses - admin% x GGR - tax% x GGR - chargebacks - fees
`negative_carryover`	boolean
`blocked_countries`	array of string
`geo_list_id`	string
`require_kyc`	boolean
`status`	enum: `active`, `paused`, `archived`
`description`	string

IgamingCreativeApproval

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`brand_id`	string
`creative_id`	string
`status`	enum: `pending`, `approved`, `rejected`
`note`	string
`decided_by`	string	read-only
`decided_at`	string (date-time)	read-only

IgamingCreativeApprovalCreate

Field	Type	Flags
`brand_id`	string	required
`creative_id`	string	required
`status`	enum: `pending`, `approved`, `rejected`
`note`	string

IgamingCreativeApprovalList

Field	Type	Flags	Description
`data`	array of IgamingCreativeApproval	required
`page`	Page	required

IgamingCreativeApprovalUpdate

Field	Type	Flags	Description
`brand_id`	string
`creative_id`	string
`status`	enum: `pending`, `approved`, `rejected`
`note`	string

IgamingDeal

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`brand_id`	string
`plan_id`	string
`valid_from`	string (date)
`valid_to`	string (date)
`status`	enum: `active`, `paused`, `ended`
`description`	string

IgamingDealCreate

Field	Type	Flags
`partner_id`	string	required
`brand_id`	string	required
`plan_id`	string	required
`valid_from`	string (date)	required
`valid_to`	string (date)
`status`	enum: `active`, `paused`, `ended`
`description`	string

IgamingDealList

Field	Type	Flags	Description
`data`	array of IgamingDeal	required
`page`	Page	required

IgamingDealUpdate

Field	Type	Flags	Description
`partner_id`	string
`brand_id`	string
`plan_id`	string
`valid_from`	string (date)
`valid_to`	string (date)
`status`	enum: `active`, `paused`, `ended`
`description`	string

IgamingPlan

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`type`	enum: `cpa`, `revshare`, `hybrid`
`brand_id`	string
`config`	object (free-form)		cpa{amount,min_deposit,min_wager,within_days,countries[],require_kyc}, revshare{metric ngr\|players, tier_mode highest\|marginal, tiers[{from,percent}]}, sub_affiliate_percents[]
`status`	string
`description`	string

IgamingPlanCreate

Field	Type	Flags	Description
`name`	string	required
`type`	enum: `cpa`, `revshare`, `hybrid`	required
`brand_id`	string
`config`	object (free-form)		cpa{amount,min_deposit,min_wager,within_days,countries[],require_kyc}, revshare{metric ngr\|players, tier_mode highest\|marginal, tiers[{from,percent}]}, sub_affiliate_percents[]
`status`	string
`description`	string

IgamingPlanList

Field	Type	Flags	Description
`data`	array of IgamingPlan	required
`page`	Page	required

IgamingPlanUpdate

Field	Type	Description
`name`	string
`type`	enum: `cpa`, `revshare`, `hybrid`
`brand_id`	string
`config`	object (free-form)	cpa{amount,min_deposit,min_wager,within_days,countries[],require_kyc}, revshare{metric ngr\|players, tier_mode highest\|marginal, tiers[{from,percent}]}, sub_affiliate_percents[]
`status`	string
`description`	string

IgamingPlayer

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`brand_id`	string	read-only
`brand_player_id`	string	read-only
`partner_id`	string
`click_id`	string
`tracking_code`	string
`promo_code`	string
`attribution`	string	read-only
`country`	string
`signup_at`	string (date-time)
`ftd_at`	string (date-time)	read-only
`ftd_amount`	string	read-only	decimal string
`status`	enum: `active`, `blocked`, `closed`
`kyc_status`	enum: `pending`, `verified`, `rejected`

IgamingPlayerList

Field	Type	Flags	Description
`data`	array of IgamingPlayer	required
`page`	Page	required

IgamingPlayerUpdate

Field	Type	Flags	Description
`partner_id`	string
`click_id`	string
`tracking_code`	string
`promo_code`	string
`country`	string
`signup_at`	string (date-time)
`status`	enum: `active`, `blocked`, `closed`
`kyc_status`	enum: `pending`, `verified`, `rejected`

IgamingPromoCode

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`brand_id`	string
`code`	string
`kind`	enum: `promo`, `tracking`
`partner_id`	string
`bonus_description`	string
`valid_from`	string (date-time)
`valid_to`	string (date-time)
`status`	enum: `active`, `paused`, `expired`

IgamingPromoCodeCreate

Field	Type	Flags
`brand_id`	string	required
`code`	string	required
`kind`	enum: `promo`, `tracking`
`partner_id`	string	required
`bonus_description`	string
`valid_from`	string (date-time)
`valid_to`	string (date-time)
`status`	enum: `active`, `paused`, `expired`

IgamingPromoCodeList

Field	Type	Flags	Description
`data`	array of IgamingPromoCode	required
`page`	Page	required

IgamingPromoCodeUpdate

Field	Type	Flags	Description
`brand_id`	string
`code`	string
`kind`	enum: `promo`, `tracking`
`partner_id`	string
`bonus_description`	string
`valid_from`	string (date-time)
`valid_to`	string (date-time)
`status`	enum: `active`, `paused`, `expired`

IgamingResult

iGaming ingestion/report/statement payload

Type: object (free-form)

IgamingRun

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`brand_id`	string
`period_month`	string (date)
`seq`	integer
`status`	enum: `preview`, `posted`, `discarded`
`totals`	object (free-form)
`diff`	object (free-form)		changed[] lines versus what is already posted
`warnings`	array of string
`approved_by`	string
`posted_at`	string (date-time)

IgamingRunList

Field	Type	Flags	Description
`data`	array of IgamingRun	required
`page`	Page	required

ImpersonateLink

url, expires_at, user_email, partner_id, session_minutes

Type: object (free-form)

ImportJob

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`source_id`	string
`platform`	string
`mode`	enum: `api`, `csv`
`status`	enum: `draft`, `dry_running`, `dry_run_done`, `queued`, `running`, `completed`, `failed`, `cancelled`
`options`	object (free-form)		kinds[], chunk_size, adopt, file_kinds[]
`files`	object (free-form)		csv mode, create only: kind -> csv text
`mappings`	object (free-form)		csv mode, create only: kind -> {columns,defaults}
`checkpoint`	object (free-form)
`progress`	object (free-form)		kind -> {fetched,created,updated,skipped,conflict,error}
`summary`	object (free-form)
`progress_pct`	integer
`error`	string
`cancel_requested`	boolean

ImportMapping

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`platform`	enum: `generic`, `tune`, `everflow`, `trackier`, `affise`, `cake`
`entity`	enum: `advertisers`, `partners`, `offers`, `partner_offers`, `domains`
`mapping`	object (free-form)		columns{csv header: canonical field}, defaults{field: constant}

ImportMappingCreate

Field	Type	Flags	Description
`name`	string	required
`platform`	enum: `generic`, `tune`, `everflow`, `trackier`, `affise`, `cake`
`entity`	enum: `advertisers`, `partners`, `offers`, `partner_offers`, `domains`	required
`mapping`	object (free-form)	required	columns{csv header: canonical field}, defaults{field: constant}

ImportMappingList

Field	Type	Flags	Description
`data`	array of ImportMapping	required
`page`	Page	required

ImportMappingUpdate

Field	Type	Description
`name`	string
`platform`	enum: `generic`, `tune`, `everflow`, `trackier`, `affise`, `cake`
`entity`	enum: `advertisers`, `partners`, `offers`, `partner_offers`, `domains`
`mapping`	object (free-form)	columns{csv header: canonical field}, defaults{field: constant}

ImportSchedule

Scheduled offer import from another network (an import source on a frequency, filtered, onto one advertiser)

Field	Type	Description
`id`	string
`name`	string
`source_id`	string
`source_name`	string
`platform`	string
`advertiser_id`	string
`advertiser_name`	string
`frequency`	enum: `hourly`, `every_6_hours`, `daily`, `weekly`
`run_hour`	integer
`filters`	object (free-form)	statuses[], name_contains, external_ids[], visibility[], currencies[], max_offers
`enabled`	boolean
`next_run_at`	string (date-time)
`last_run_at`	string (date-time)
`last_job_id`	string
`runs`	integer
`last_run`	object (free-form)	status, progress, error, finished_at
`created_at`	string (date-time)
`updated_at`	string (date-time)

ImportScheduleInput

Field	Type	Description
`name`	string
`source_id`	string
`advertiser_id`	string
`frequency`	enum: `hourly`, `every_6_hours`, `daily`, `weekly`
`run_hour`	integer
`filters`	object (free-form)	statuses[], name_contains, external_ids[], visibility[], currencies[], max_offers
`enabled`	boolean

ImportScheduleList

Field	Type	Flags	Description
`data`	array of ImportSchedule
`total`	integer
`frequencies`	array of string

ImportSchedulePreview

Field	Type	Flags	Description
`data`	array of object (free-form)
`more`	boolean

ImportSchedulePreviewRequest

Field	Type	Flags	Description
`source_id`	string	required
`filters`	object (free-form)

ImportScheduleQueued

Field	Type	Flags	Description
`job_id`	string
`status`	string

ImportScheduleRuns

Field	Type	Flags	Description
`data`	array of object (free-form)
`total`	integer

ImportSource

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`platform`	enum: `tune`, `everflow`, `trackier`, `affise`, `cake`	required
`name`	string	required
`base_url`	string
`config`	object (free-form)		api_key (write-only, returned masked), network_id, extra{}
`status`	enum: `active`, `disabled`
`last_tested_at`	string (date-time)
`last_error`	string

InvitationCreate

Field	Type	Flags	Description
`email`	string (email)	required
`principal_type`	enum: `employee`, `partner`, `advertiser`
`principal_id`	string		partner or advertiser id (portal users)
`role_key`	string
`name`	string

InviteAccept

Field	Type	Flags
`token`	string	required
`password`	string	required
`name`	string

InviteAccepted

Field	Type	Flags	Description
`ok`	boolean
`next`	string

InvoiceSearchResult

data[] invoices with advertiser_name, paid, outstanding, overdue, days_overdue; page {total}

Type: object (free-form)

Job

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`kind`	string
`status`	enum: `queued`, `running`, `done`, `failed`, `cancelled`
`progress`	integer
`params`	object (free-form)
`result`	object (free-form)
`result_file_ref`	string
`error`	string
`started_at`	string (date-time)
`finished_at`	string (date-time)

JobList

Field	Type	Flags	Description
`data`	array of Job	required
`page`	Page	required

KYCDocument

id, partner_id, doc_type, file_name, content_type, size_bytes, status (pending|accepted|rejected), note, uploaded_by_type, reviewed_by, reviewed_at, created_at

Type: object (free-form)

KYCDocumentReview

status accepted|rejected|pending, note

Type: object (free-form)

Label

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`color`	string

LabelCreate

Field	Type	Flags	Description
`name`	string	required
`color`	string

LabelList

Field	Type	Flags	Description
`data`	array of Label	required
`page`	Page	required

LabelUpdate

Field	Type	Flags	Description
`name`	string
`color`	string

LandingPage

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`offer_id`	string	read-only
`title`	string
`url`	string
`preview_url`	string
`lp_type`	enum: `landing`, `prelanding`, `targeting_group`
`status`	string
`is_default`	boolean
`split_urls`	array of object (free-form)
`weight`	integer
`rule_set_id`	string
`partner_visibility`	enum: `all`, `specific`
`partner_ids`	array of string

LandingPageCreate

Field	Type	Flags
`title`	string	required
`url`	string	required
`preview_url`	string
`lp_type`	enum: `landing`, `prelanding`, `targeting_group`
`status`	string
`is_default`	boolean
`split_urls`	array of object (free-form)
`weight`	integer
`rule_set_id`	string
`partner_visibility`	enum: `all`, `specific`
`partner_ids`	array of string

LandingPageList

Field	Type	Flags	Description
`data`	array of LandingPage	required
`page`	Page	required

LandingPageUpdate

Field	Type	Flags	Description
`title`	string
`url`	string
`preview_url`	string
`lp_type`	enum: `landing`, `prelanding`, `targeting_group`
`status`	string
`is_default`	boolean
`split_urls`	array of object (free-form)
`weight`	integer
`rule_set_id`	string
`partner_visibility`	enum: `all`, `specific`
`partner_ids`	array of string

Lead

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`vertical_id`	string	read-only
`partner_id`	string	read-only
`form_id`	string	read-only
`status`	enum: `received`, `processing`, `sold`, `unsold`, `rejected`, `duplicate`, `returned`	read-only
`reject_reason`	string	read-only
`external_id`	string	read-only
`fields`	object (free-form)		validated field values
`consent`	object (free-form)
`ip`	string
`sub1`	string
`sub2`	string
`sub3`	string
`mode`	string
`sold_count`	integer
`returned_count`	integer
`revenue`	string		decimal string
`payout`	string		decimal string
`currency`	string
`ping_count`	integer
`post_count`	integer
`events`	array of object (free-form)
`sales`	array of object (free-form)
`returns`	array of object (free-form)

LeadBuyer

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`advertiser_id`	string
`status`	enum: `active`, `paused`, `archived`
`contact_email`	string
`notes`	string
`currency`	string

LeadBuyerCreate

Field	Type	Flags
`name`	string	required
`advertiser_id`	string
`status`	enum: `active`, `paused`, `archived`
`contact_email`	string
`notes`	string
`currency`	string

LeadBuyerList

Field	Type	Flags	Description
`data`	array of LeadBuyer	required
`page`	Page	required

LeadBuyerUpdate

Field	Type	Flags	Description
`name`	string
`advertiser_id`	string
`status`	enum: `active`, `paused`, `archived`
`contact_email`	string
`notes`	string
`currency`	string

LeadCampaign

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`buyer_id`	string
`vertical_id`	string
`name`	string
`status`	enum: `draft`, `active`, `paused`, `archived`
`priority`	integer
`weight`	integer
`filters`	array of object (free-form)
`filter_match`	enum: `all`, `any`
`caps`	object (free-form)		hourly, daily
`schedule`	object (free-form)		timezone, windows[{days[1-7],from,to}]
`pricing_type`	enum: `fixed`, `bid`
`price`	string		decimal string
`bid_floor`	string		decimal string
`bid_ceiling`	string		decimal string
`accepts_shared`	boolean
`ping_enabled`	boolean
`ping_delivery`	object (free-form)		delivery spec: kind, url, method, format json\|form\|xml, headers, auth, map[{to,from,value,template,transform,type,required}], body, root, email
`ping_response`	object (free-form)		response spec: accept/reject{status[],path,equals[],regex,contains}, price_path, reason_path, ref_path
`delivery`	object (free-form)		delivery spec (see ping_delivery)
`post_response`	object (free-form)		response spec (see ping_response)
`timeout_ms`	integer
`return_auto_approve_hours`	integer
`currency`	string

LeadCampaignCreate

Field	Type	Flags	Description
`buyer_id`	string	required
`vertical_id`	string	required
`name`	string	required
`status`	enum: `draft`, `active`, `paused`, `archived`
`priority`	integer
`weight`	integer
`filters`	array of object (free-form)
`filter_match`	enum: `all`, `any`
`caps`	object (free-form)		hourly, daily
`schedule`	object (free-form)		timezone, windows[{days[1-7],from,to}]
`pricing_type`	enum: `fixed`, `bid`
`price`	string		decimal string
`bid_floor`	string		decimal string
`bid_ceiling`	string		decimal string
`accepts_shared`	boolean
`ping_enabled`	boolean
`ping_delivery`	object (free-form)		delivery spec: kind, url, method, format json\|form\|xml, headers, auth, map[{to,from,value,template,transform,type,required}], body, root, email
`ping_response`	object (free-form)		response spec: accept/reject{status[],path,equals[],regex,contains}, price_path, reason_path, ref_path
`delivery`	object (free-form)		delivery spec (see ping_delivery)
`post_response`	object (free-form)		response spec (see ping_response)
`timeout_ms`	integer
`return_auto_approve_hours`	integer
`currency`	string

LeadCampaignList

Field	Type	Flags	Description
`data`	array of LeadCampaign	required
`page`	Page	required

LeadCampaignUpdate

Field	Type	Description
`buyer_id`	string
`vertical_id`	string
`name`	string
`status`	enum: `draft`, `active`, `paused`, `archived`
`priority`	integer
`weight`	integer
`filters`	array of object (free-form)
`filter_match`	enum: `all`, `any`
`caps`	object (free-form)	hourly, daily
`schedule`	object (free-form)	timezone, windows[{days[1-7],from,to}]
`pricing_type`	enum: `fixed`, `bid`
`price`	string	decimal string
`bid_floor`	string	decimal string
`bid_ceiling`	string	decimal string
`accepts_shared`	boolean
`ping_enabled`	boolean
`ping_delivery`	object (free-form)	delivery spec: kind, url, method, format json\|form\|xml, headers, auth, map[{to,from,value,template,transform,type,required}], body, root, email
`ping_response`	object (free-form)	response spec: accept/reject{status[],path,equals[],regex,contains}, price_path, reason_path, ref_path
`delivery`	object (free-form)	delivery spec (see ping_delivery)
`post_response`	object (free-form)	response spec (see ping_response)
`timeout_ms`	integer
`return_auto_approve_hours`	integer
`currency`	string

LeadField

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`vertical_id`	string
`key`	string
`label`	string
`type`	enum: `text`, `email`, `phone`, `zip`, `number`, `decimal`, `date`, `select`, `boolean`, `state`, `country`, `url`, ...
`required`	boolean
`pii`	boolean
`consent`	boolean		TCPA/consent field (boolean)
`send_in_ping`	boolean
`validation`	object (free-form)		min, max, min_length, max_length, regex, options[]
`default_value`	string
`help`	string
`position`	integer

LeadFieldCreate

Field	Type	Flags	Description
`vertical_id`	string	required
`key`	string	required
`label`	string
`type`	enum: `text`, `email`, `phone`, `zip`, `number`, `decimal`, `date`, `select`, `boolean`, `state`, `country`, `url`, ...
`required`	boolean
`pii`	boolean
`consent`	boolean		TCPA/consent field (boolean)
`send_in_ping`	boolean
`validation`	object (free-form)		min, max, min_length, max_length, regex, options[]
`default_value`	string
`help`	string
`position`	integer

LeadFieldList

Field	Type	Flags	Description
`data`	array of LeadField	required
`page`	Page	required

LeadFieldUpdate

Field	Type	Description
`vertical_id`	string
`key`	string
`label`	string
`type`	enum: `text`, `email`, `phone`, `zip`, `number`, `decimal`, `date`, `select`, `boolean`, `state`, `country`, `url`, ...
`required`	boolean
`pii`	boolean
`consent`	boolean	TCPA/consent field (boolean)
`send_in_ping`	boolean
`validation`	object (free-form)	min, max, min_length, max_length, regex, options[]
`default_value`	string
`help`	string
`position`	integer

LeadForm

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`vertical_id`	string
`partner_id`	string
`name`	string
`slug`	string
`status`	enum: `active`, `paused`, `archived`
`fields`	array of string
`title`	string
`consent_text`	string
`success_message`	string
`redirect_url`	string
`theme`	object (free-form)
`allowed_origins`	array of string

LeadFormCreate

Field	Type	Flags
`vertical_id`	string	required
`partner_id`	string
`name`	string	required
`slug`	string
`status`	enum: `active`, `paused`, `archived`
`fields`	array of string
`title`	string
`consent_text`	string
`success_message`	string
`redirect_url`	string
`theme`	object (free-form)
`allowed_origins`	array of string

LeadFormList

Field	Type	Flags	Description
`data`	array of LeadForm	required
`page`	Page	required

LeadFormUpdate

Field	Type	Flags	Description
`vertical_id`	string
`partner_id`	string
`name`	string
`slug`	string
`status`	enum: `active`, `paused`, `archived`
`fields`	array of string
`title`	string
`consent_text`	string
`success_message`	string
`redirect_url`	string
`theme`	object (free-form)
`allowed_origins`	array of string

LeadList

Field	Type	Flags	Description
`data`	array of Lead	required
`page`	Page	required

LeadReturn

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`sale_id`	string
`lead_id`	string
`buyer_id`	string
`campaign_id`	string
`partner_id`	string
`reason_code`	enum: `invalid_contact`, `duplicate`, `unreachable`, `not_interested`, `out_of_area`, `fraud`, `compliance`, `other`
`reason`	string
`status`	enum: `requested`, `approved`, `rejected`
`amount`	string		decimal string
`payout`	string		decimal string
`currency`	string
`requested_by`	string
`requested_at`	string (date-time)
`auto_approve_at`	string (date-time)
`decided_by`	string
`decided_at`	string (date-time)
`decision_note`	string

LeadReturnList

Field	Type	Flags	Description
`data`	array of LeadReturn	required
`page`	Page	required

LeadReturnRequest

Field	Type	Flags	Description
`reason_code`	enum: `invalid_contact`, `duplicate`, `unreachable`, `not_interested`, `out_of_area`, `fraud`, `compliance`, `other`	required
`reason`	string

LeadSale

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`lead_id`	string
`campaign_id`	string
`buyer_id`	string
`vertical_id`	string
`partner_id`	string
`advertiser_id`	string
`status`	enum: `sold`, `returned`
`exclusive`	boolean
`price`	string		decimal string
`payout`	string		decimal string
`currency`	string
`sold_at`	string (date-time)
`return_window_ends_at`	string (date-time)
`returned_at`	string (date-time)
`buyer_ref`	string

LeadSaleList

Field	Type	Flags	Description
`data`	array of LeadSale	required
`page`	Page	required

LeadSubmit

Field	Type	Flags	Description
`vertical`	string	required	vertical id or slug
`fields`	object (free-form)	required	field key -> value (validated against the vertical schema)
`partner_id`	string		required for non-partner credentials
`external_id`	string		supplier idempotency key
`sub1`	string
`sub2`	string
`sub3`	string
`ip`	string
`user_agent`	string
`consent_text`	string

LeadSubmitResult

Field	Type	Description
`id`	string
`display_id`	integer
`status`	enum: `sold`, `unsold`
`sold`	boolean
`payout`	string	decimal string
`currency`	string
`idempotent`	boolean
`revenue`	string	decimal string
`sold_count`	integer

LeadSupplierTerm

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`vertical_id`	string
`payout_type`	enum: `percent`, `fixed`
`amount`	string		decimal string
`min_price`	string		decimal string
`status`	enum: `active`, `paused`

LeadSupplierTermCreate

Field	Type	Flags	Description
`partner_id`	string	required
`vertical_id`	string
`payout_type`	enum: `percent`, `fixed`
`amount`	string		decimal string
`min_price`	string		decimal string
`status`	enum: `active`, `paused`

LeadSupplierTermList

Field	Type	Flags	Description
`data`	array of LeadSupplierTerm	required
`page`	Page	required

LeadSupplierTermUpdate

Field	Type	Description
`partner_id`	string
`vertical_id`	string
`payout_type`	enum: `percent`, `fixed`
`amount`	string	decimal string
`min_price`	string	decimal string
`status`	enum: `active`, `paused`

LeadTestSend

Field	Type	Description
`phase`	enum: `ping`, `post`
`fields`	object (free-form)	sample values; synthesised from the schema when omitted
`price`	string	decimal string
`send`	boolean	actually perform the call (SSRF-guarded)

LeadVertical

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`slug`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`mode`	enum: `auction`, `priority`, `round_robin`, `waterfall`
`max_sales`	integer
`ping_timeout_ms`	integer
`post_timeout_ms`	integer
`return_window_hours`	integer
`dedupe_field`	string
`dedupe_days`	integer
`require_consent`	boolean

LeadVerticalCreate

Field	Type	Flags
`name`	string	required
`slug`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`mode`	enum: `auction`, `priority`, `round_robin`, `waterfall`
`max_sales`	integer
`ping_timeout_ms`	integer
`post_timeout_ms`	integer
`return_window_hours`	integer
`dedupe_field`	string
`dedupe_days`	integer
`require_consent`	boolean

LeadVerticalList

Field	Type	Flags	Description
`data`	array of LeadVertical	required
`page`	Page	required

LeadVerticalUpdate

Field	Type	Flags	Description
`name`	string
`slug`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`mode`	enum: `auction`, `priority`, `round_robin`, `waterfall`
`max_sales`	integer
`ping_timeout_ms`	integer
`post_timeout_ms`	integer
`return_window_hours`	integer
`dedupe_field`	string
`dedupe_days`	integer
`require_consent`	boolean

LedgerBalance

Field	Type	Description
`account`	string
`currency`	string
`balance`	string	decimal string
`as_of`	string (date-time)

LedgerBalanceList

Field	Type	Flags	Description
`data`	array of LedgerBalance

LedgerEntry

Field	Type	Description
`id`	string
`ts`	string (date-time)
`effective_date`	string (date)
`journal_id`	string
`account`	string
`debit`	string	decimal string
`credit`	string	decimal string
`currency`	string
`amount_tenant_ccy`	string	decimal string
`fx_rate`	string	decimal string
`source_type`	string
`source_id`	string
`memo`	string
`reversal_of`	string

LedgerEntryList

Field	Type	Flags	Description
`data`	array of LedgerEntry
`page`	Page

LegacyDomain

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`host`	string
`platform`	enum: `tune`, `everflow`, `trackier`, `affise`, `cake`
`id_map_strategy`	enum: `id_map`, `native`
`param_map`	object (free-form)		tenant overrides: legacy param -> canonical param
`status`	enum: `active`, `disabled`
`notes`	string

LegacyDomainCreate

Field	Type	Flags	Description
`host`	string	required
`platform`	enum: `tune`, `everflow`, `trackier`, `affise`, `cake`	required
`id_map_strategy`	enum: `id_map`, `native`
`param_map`	object (free-form)		tenant overrides: legacy param -> canonical param
`status`	enum: `active`, `disabled`
`notes`	string

LegacyDomainList

Field	Type	Flags	Description
`data`	array of LegacyDomain	required
`page`	Page	required

LegacyDomainUpdate

Field	Type	Description
`host`	string
`platform`	enum: `tune`, `everflow`, `trackier`, `affise`, `cake`
`id_map_strategy`	enum: `id_map`, `native`
`param_map`	object (free-form)	tenant overrides: legacy param -> canonical param
`status`	enum: `active`, `disabled`
`notes`	string

LinkTestRequest

Field	Type	Flags	Description
`url`	string	required	Tracking link (absolute, on one of your tracking domains) or a path such as /c/OFFER_HASH/PARTNER_HASH?sub1=x
`test`	boolean		Mark the click as test traffic (stored, shown in logs with is_test, excluded from reports and the ledger)
`headers`	object (free-form)		Extra request headers to send to the edge (for example User-Agent or X-Geo-Country)

List

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`kind`	enum: `ip`, `isp`, `subid`, `domain`, `referrer`, `suppression`, `email_suppression`, `asn`, `device_id`, `custom`
`values`	array of string
`file_ref`	string
`size`	integer	read-only
`description`	string
`status`	enum: `active`, `paused`
`source_url`	string
`sync_interval_minutes`	integer
`last_synced_at`	string (date-time)	read-only
`last_sync_error`	string	read-only

ListCreate

Field	Type	Flags
`name`	string	required
`kind`	enum: `ip`, `isp`, `subid`, `domain`, `referrer`, `suppression`, `email_suppression`, `asn`, `device_id`, `custom`	required
`values`	array of string
`file_ref`	string
`description`	string
`status`	enum: `active`, `paused`
`source_url`	string
`sync_interval_minutes`	integer

ListList

Field	Type	Flags	Description
`data`	array of List	required
`page`	Page	required

ListUpdate

Field	Type	Flags	Description
`name`	string
`kind`	enum: `ip`, `isp`, `subid`, `domain`, `referrer`, `suppression`, `email_suppression`, `asn`, `device_id`, `custom`
`values`	array of string
`file_ref`	string
`description`	string
`status`	enum: `active`, `paused`
`source_url`	string
`sync_interval_minutes`	integer

ListUsage

data {list_id: rule_set_count}

Type: object (free-form)

ListValues

data[] {value, valid}; page {page, page_size, total}; list {id, name, kind, size, invalid}; used_by[] {id, name, scope_entity_type, scope_entity_id}

Type: object (free-form)

LogSearchRequest

Field	Type	Description
`from`	string (date-time)
`to`	string (date-time)
`timezone`	string
`filters`	array of object (free-form)
`search`	object (free-form)	type, value
`fields`	array of string
`limit`	integer
`cursor`	string
`sort`	object (free-form)

LogSearchResult

Field	Type	Flags	Description
`rows`	array of object (free-form)
`next_cursor`	string
`has_more`	boolean

LoginHistory

rows[] of sessions {email, ip, device, auth_method, mfa, created_at, last_seen_at, state, current}, has_more

Type: object (free-form)

LoginRequest

Field	Type	Flags
`email`	string	required
`password`	string	required
`tenant_slug`	string

LoginResult

Field	Type	Flags	Description
`mfa_required`	boolean
`session_token`	string
`user`	User
`memberships`	array of object (free-form)

LoginSession

Field	Type	Flags
`id`	string
`user_id`	string
`email`	string
`name`	string
`principal_type`	enum: `employee`, `partner`, `advertiser`
`party_id`	string
`ip`	string
`user_agent`	string
`browser`	string
`os`	string
`auth_method`	string
`created_at`	string (date-time)
`last_seen_at`	string (date-time)
`expires_at`	string (date-time)
`revoked_at`	string (date-time)	nullable
`status`	enum: `active`, `expired`, `revoked`
`current`	boolean

LoginSessionList

Field	Type	Flags	Description
`data`	array of LoginSession

MMPTemplateList

Field	Type	Flags	Description
`data`	array of object (free-form)

McpAuthServerMetadata

Field	Type	Flags	Description
`issuer`	string
`authorization_endpoint`	string
`token_endpoint`	string
`registration_endpoint`	string
`response_types_supported`	array of string
`grant_types_supported`	array of string
`code_challenge_methods_supported`	array of string
`token_endpoint_auth_methods_supported`	array of string
`scopes_supported`	array of string

McpClient

Field	Type	Flags	Description
`client_id`	string
`client_id_issued_at`	integer
`client_name`	string
`redirect_uris`	array of string
`grant_types`	array of string
`response_types`	array of string
`token_endpoint_auth_method`	string

McpClientRegistration

Field	Type	Flags
`client_name`	string
`redirect_uris`	array of string	required
`token_endpoint_auth_method`	enum: `none`
`grant_types`	array of string

McpInfo

Field	Type	Flags	Description
`audience`	string
`endpoint`	string
`endpoint_path`	string
`scopes`	array of object (free-form)
`tools`	array of object (free-form)
`rate_limit_per_minute`	integer
`max_expiry_days`	integer
`default_expiry_days`	integer
`can_create`	boolean

McpJsonRpc

JSON-RPC 2.0 message (initialize, tools/list, tools/call, resources/, prompts/)

Field	Type	Flags
`jsonrpc`	enum: `2.0`	required
`id`	object (free-form)
`method`	string	required
`params`	object (free-form)

McpJsonRpcResult

Field	Type	Flags	Description
`jsonrpc`	string
`id`	object (free-form)
`result`	object (free-form)
`error`	object (free-form)

McpOAuthToken

Field	Type	Flags	Description
`access_token`	string
`token_type`	string
`expires_in`	integer
`refresh_token`	string
`scope`	string

McpResourceMetadata

Field	Type	Flags	Description
`resource`	string
`resource_name`	string
`scopes_supported`	array of string
`bearer_methods_supported`	array of string
`resource_documentation`	string

McpToken

Field	Type	Flags	Description
`id`	string
`name`	string
`key_prefix`	string
`audience`	enum: `network`, `partner`, `advertiser`
`principal_id`	string
`scopes`	array of string
`expires_at`	string (date-time)
`last_used_at`	string (date-time)
`status`	enum: `active`, `revoked`, `expired`
`created_at`	string (date-time)
`created_by`	string
`created_by_email`	string
`revoked_at`	string (date-time)

McpTokenCreate

Field	Type	Flags
`name`	string	required
`scopes`	array of enum: `reports:read`, `entities:read`, `logs:read`, `billing:read`, `fraud:read`, `offers:write`, `approvals:write`, `conversions:write`, `links:write`, `postbacks:write`	required
`expires_in_days`	integer

McpTokenCreated

Field	Type	Description
`id`	string
`name`	string
`token`	string	shown once
`key_prefix`	string
`scopes`	array of string
`expires_at`	string (date-time)
`created_at`	string (date-time)
`audience`	string
`status`	string
`endpoint`	string

McpTokenList

Field	Type	Flags	Description
`data`	array of McpToken
`page`	object (free-form)

McpUsage

Field	Type	Flags	Description
`tools`	array of object (free-form)
`tokens`	array of object (free-form)
`recent`	array of object (free-form)
`window_days`	integer

MessageStats

days, messages {id: {total, sent, failed, unsubscribed, opened, clicked}}, daily[] {day, sent, opened, clicked}, status_counts

Type: object (free-form)

MessageTemplate

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`channel`	enum: `email`, `in_app`
`subject`	string
`body_html`	string
`body_text`	string

MessageTemplateCreate

Field	Type	Flags
`name`	string	required
`channel`	enum: `email`, `in_app`
`subject`	string
`body_html`	string
`body_text`	string

MessageTemplateList

Field	Type	Flags	Description
`data`	array of MessageTemplate	required
`page`	Page	required

MessageTemplateUpdate

Field	Type	Flags	Description
`name`	string
`channel`	enum: `email`, `in_app`
`subject`	string
`body_html`	string
`body_text`	string

MessageTestResult

ok, via (provider|platform_smtp), to

Type: object (free-form)

MessageTestSend

to (optional, defaults to the caller's email)

Type: object (free-form)

MobileQuery

Field	Type	Flags
`from`	string (date)	required
`to`	string (date)	required
`dimensions`	array of enum: `app`, `app_id`, `platform`, `partner`, `partner_id`, `offer`, `country`, `install_date`, `match_type`, `install_kind`
`metrics`	array of string
`filters`	array of object (free-form)
`sort`	array of object (free-form)
`limit`	integer
`days`	array of integer
`cohort_by`	string
`cohort_kind`	enum: `retention`, `ltv`, `active`

MyNotificationPrefs

kinds[] {kind, email (bool)} — the staff alerts this member can switch off; security and account mail always go out

Type: object (free-form)

MyNotificationPrefsUpdate

prefs {kind: {email: bool}} (kinds from GET)

Type: object (free-form)

NetworkDirectory

Field	Type	Description
`partners`	object (free-form)	total, data[] {id, name, status}
`advertisers`	object (free-form)
`offers`	object (free-form)
`settings`	object (free-form)	reporting_timezone, default_currency, locale, data_region, modes
`portal_hosts`	object (free-form)
`organization`	object (free-form)
`network`	object (free-form)

NetworkMoved

Field	Type	Flags	Description
`tenant_id`	string
`from_organization`	string
`to_organization`	string
`org_sessions_revoked`	integer

NetworkPeople

Field	Type	Flags	Description
`staff`	array of object (free-form)
`partner_users`	array of object (free-form)
`advertiser_users`	array of object (free-form)
`invitations`	array of object (free-form)
`owner_user_id`	string

NetworkProvision

Field	Type	Flags
`name`	string	required
`slug`	string	required
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`data_region`	enum: `us`, `eu`, `in`, `ap`
`locale`	string
`owner_email`	string (email)	required
`owner_name`	string
`sample_data`	boolean
`organization_id`	string
`reason`	string

NetworkProvisioned

Field	Type	Flags	Description
`tenant`	OperatorTenant		A workspace as the operator sees it (counts only, no tenant data)
`owner_invited`	string

Note

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`entity_type`	string
`entity_id`	string
`body`	string
`pinned`	boolean
`author_id`	string	read-only

NoteCreate

Field	Type	Flags
`entity_type`	string
`entity_id`	string
`body`	string	required
`pinned`	boolean

NoteList

Field	Type	Flags	Description
`data`	array of Note	required
`page`	Page	required

Notification

Field	Type	Flags	Description
`id`	string
`kind`	string
`message`	string
`resource_link`	string
`related`	object (free-form)
`read_at`	string (date-time)
`created_at`	string (date-time)

NotificationList

Field	Type	Flags	Description
`data`	array of Notification
`page`	Page

NotificationPreferences

events[] {kind, group, audiences[], team_email, party_email}, in_app

Type: object (free-form)

NotificationPreferencesUpdate

settings {kind: {team_email, party_email}}

Type: object (free-form)

NotificationPrefs

prefs{kind: {in_app, email}}, kinds[]

Type: object (free-form)

NotificationRead

ids[], all, unread

Type: object (free-form)

NotificationSummary

unread

Type: object (free-form)

Offer

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`advertiser_id`	string
`offer_group_id`	string
`description_html`	string
`is_description_plain_text`	boolean
`internal_notes`	string
`thumbnail_url`	string
`preview_url`	string
`category_ids`	array of string
`tags`	array of string
`channel_ids`	array of string
`vertical`	enum: `web`, `mobile_app`, `igaming`, `lead_gen`, `ecommerce`, `call`
`app_identifier`	string
`app_name`	string
`erid`	string
`project_id`	string
`external_offer_id`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `expired`, `deleted`, `archived`
`inactive_reason`	string
`visibility`	enum: `public`, `require_approval`, `private`
`start_at`	string (date-time)
`end_at`	string (date-time)
`expire_action`	enum: `pause`, `fallback`
`schedule`	object (free-form)		timezone, start_hour, end_hour, day_parting[{day_of_week,start_hour,start_minute,end_hour,end_minute}]
`currency`	string
`commission_model`	enum: `cpa`, `cpi`, `cpl`, `cps`, `cpm`, `cpc`, `cpe`, `revshare`, `hybrid`, `kpi`
`payout_calc_param`	string
`default_goal_name`	string
`destination_url`	string
`impression_url`	string
`server_side_url`	string
`view_through_destination_url`	string
`fallback_url`	string
`fallback_offer_id`	string
`is_allow_deep_link`	boolean
`deep_link_allowed_domains`	array of string
`tracking_domain_id`	string
`conversion_tracking_domain_id`	string
`is_use_secure_link`	boolean
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`max_hops`	integer
`allowed_tracking_link_format`	enum: `numeric_id`, `unique_id`, `both`
`conversion_method`	enum: `server_postback`, `image_pixel`, `iframe_pixel`, `javascript_sdk`, `cookie_based`, `gtm`, `shopify`, `s2s_event_api`, `coupon_code`, `call`
`is_whitelist_check_enabled`	boolean
`session_definition`	enum: `cookie`, `ip`, `ip_user_agent`, `gaid`, `idfa`, `click_id_only`
`session_duration_hours`	integer
`unique_click_session_hours`	integer
`duplicate_click_action`	enum: `count`, `block`, `fail_traffic`
`already_converted_action`	enum: `allow`, `block`, `fail_traffic`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`attribution_priority`	array of enum: `click_id`, `cookie`, `fingerprint`, `email`, `coupon`		WP-80: matching order for this offer's conversions; empty = default ladder (click_id, cookie, coupon; fingerprint and email off)
`sku_payouts`	array of object		WP-80: per-SKU payout / revenue per line item (flat per unit or percent of the line amount); a conversion carrying SKU lines is priced as the sum of its lines
`ctit_min_seconds`	integer
`ctit_max_hours`	integer
`is_view_through_enabled`	boolean
`view_through_lifespan_minutes`	integer
`view_through_min_seconds`	integer
`allow_impressions`	boolean
`email_attribution`	object (free-form)		enabled, method, window_minutes, window_type
`track_multi_conversions`	boolean
`is_allow_duplicate_conversion`	boolean
`is_must_approve_conversion`	boolean
`default_conversion_status`	enum: `approved`, `pending`
`allow_spillover_conversions`	boolean
`cancel_fallback_conversions`	boolean
`cancel_blocked_postback_conversions`	boolean
`scrub`	object (free-form)		enabled, percentage, status pending\|rejected
`is_caps_enabled`	boolean
`caps`	object (free-form)		daily/weekly/monthly/global x conversion/payout/revenue/click, is_soft_cap, timezone
`partner_controls`	object (free-form)		blocked_partner_ids, allowed_partner_ids, subids_blocked, subids_allowed, blacklist_postback_partners, whitelist_postback_partners, source_names, application_questionnaire_id
`email_compliance`	object (free-form)
`integrations`	object (free-form)
`terms`	object (free-form)		text, is_explicit, is_force
`kpi_requirements`	array of object (free-form)
`required_tracking_parameters`	array of object (free-form)
`localized_descriptions`	object (free-form)
`flow`	array of object (free-form)
`account_manager_id`	string
`sales_manager_id`	string

OfferCloneRequest

name (default 'Copy of ...'), status (default paused), include {goals, payouts, landing_pages, caps} (all true by default)

Type: object (free-form)

OfferCloneResult

the new offer plus copied {goals, payouts, landing_pages, caps} counts

Type: object (free-form)

OfferCreate

Field	Type	Flags	Description
`name`	string	required
`advertiser_id`	string	required
`offer_group_id`	string
`description_html`	string
`is_description_plain_text`	boolean
`internal_notes`	string
`thumbnail_url`	string
`preview_url`	string
`category_ids`	array of string
`tags`	array of string
`channel_ids`	array of string
`vertical`	enum: `web`, `mobile_app`, `igaming`, `lead_gen`, `ecommerce`, `call`
`app_identifier`	string
`app_name`	string
`erid`	string
`project_id`	string
`external_offer_id`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `expired`, `deleted`, `archived`
`inactive_reason`	string
`visibility`	enum: `public`, `require_approval`, `private`
`start_at`	string (date-time)
`end_at`	string (date-time)
`expire_action`	enum: `pause`, `fallback`
`schedule`	object (free-form)		timezone, start_hour, end_hour, day_parting[{day_of_week,start_hour,start_minute,end_hour,end_minute}]
`currency`	string
`commission_model`	enum: `cpa`, `cpi`, `cpl`, `cps`, `cpm`, `cpc`, `cpe`, `revshare`, `hybrid`, `kpi`
`payout_calc_param`	string
`default_goal_name`	string
`destination_url`	string	required
`impression_url`	string
`server_side_url`	string
`view_through_destination_url`	string
`fallback_url`	string
`fallback_offer_id`	string
`is_allow_deep_link`	boolean
`deep_link_allowed_domains`	array of string
`tracking_domain_id`	string
`conversion_tracking_domain_id`	string
`is_use_secure_link`	boolean
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`max_hops`	integer
`allowed_tracking_link_format`	enum: `numeric_id`, `unique_id`, `both`
`conversion_method`	enum: `server_postback`, `image_pixel`, `iframe_pixel`, `javascript_sdk`, `cookie_based`, `gtm`, `shopify`, `s2s_event_api`, `coupon_code`, `call`
`is_whitelist_check_enabled`	boolean
`session_definition`	enum: `cookie`, `ip`, `ip_user_agent`, `gaid`, `idfa`, `click_id_only`
`session_duration_hours`	integer
`unique_click_session_hours`	integer
`duplicate_click_action`	enum: `count`, `block`, `fail_traffic`
`already_converted_action`	enum: `allow`, `block`, `fail_traffic`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`attribution_priority`	array of enum: `click_id`, `cookie`, `fingerprint`, `email`, `coupon`		WP-80: matching order for this offer's conversions; empty = default ladder (click_id, cookie, coupon; fingerprint and email off)
`sku_payouts`	array of object		WP-80: per-SKU payout / revenue per line item (flat per unit or percent of the line amount); a conversion carrying SKU lines is priced as the sum of its lines
`ctit_min_seconds`	integer
`ctit_max_hours`	integer
`is_view_through_enabled`	boolean
`view_through_lifespan_minutes`	integer
`view_through_min_seconds`	integer
`allow_impressions`	boolean
`email_attribution`	object (free-form)		enabled, method, window_minutes, window_type
`track_multi_conversions`	boolean
`is_allow_duplicate_conversion`	boolean
`is_must_approve_conversion`	boolean
`default_conversion_status`	enum: `approved`, `pending`
`allow_spillover_conversions`	boolean
`cancel_fallback_conversions`	boolean
`cancel_blocked_postback_conversions`	boolean
`scrub`	object (free-form)		enabled, percentage, status pending\|rejected
`is_caps_enabled`	boolean
`caps`	object (free-form)		daily/weekly/monthly/global x conversion/payout/revenue/click, is_soft_cap, timezone
`partner_controls`	object (free-form)		blocked_partner_ids, allowed_partner_ids, subids_blocked, subids_allowed, blacklist_postback_partners, whitelist_postback_partners, source_names, application_questionnaire_id
`email_compliance`	object (free-form)
`integrations`	object (free-form)
`terms`	object (free-form)		text, is_explicit, is_force
`kpi_requirements`	array of object (free-form)
`required_tracking_parameters`	array of object (free-form)
`localized_descriptions`	object (free-form)
`flow`	array of object (free-form)
`account_manager_id`	string
`sales_manager_id`	string

OfferGroup

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`status`	string
`advertiser_id`	string
`routing_type`	enum: `priority`, `weight`
`settings`	object (free-form)

OfferGroupCreate

Field	Type	Flags
`name`	string	required
`status`	string
`advertiser_id`	string
`routing_type`	enum: `priority`, `weight`
`settings`	object (free-form)

OfferGroupList

Field	Type	Flags	Description
`data`	array of OfferGroup	required
`page`	Page	required

OfferGroupUpdate

Field	Type	Flags	Description
`name`	string
`status`	string
`advertiser_id`	string
`routing_type`	enum: `priority`, `weight`
`settings`	object (free-form)

OfferList

Field	Type	Flags	Description
`data`	array of Offer	required
`page`	Page	required

OfferUpdate

Field	Type	Description
`name`	string
`advertiser_id`	string
`offer_group_id`	string
`description_html`	string
`is_description_plain_text`	boolean
`internal_notes`	string
`thumbnail_url`	string
`preview_url`	string
`category_ids`	array of string
`tags`	array of string
`channel_ids`	array of string
`vertical`	enum: `web`, `mobile_app`, `igaming`, `lead_gen`, `ecommerce`, `call`
`app_identifier`	string
`app_name`	string
`erid`	string
`project_id`	string
`external_offer_id`	string
`status`	enum: `active`, `pending`, `paused`, `disabled`, `expired`, `deleted`, `archived`
`inactive_reason`	string
`visibility`	enum: `public`, `require_approval`, `private`
`start_at`	string (date-time)
`end_at`	string (date-time)
`expire_action`	enum: `pause`, `fallback`
`schedule`	object (free-form)	timezone, start_hour, end_hour, day_parting[{day_of_week,start_hour,start_minute,end_hour,end_minute}]
`currency`	string
`commission_model`	enum: `cpa`, `cpi`, `cpl`, `cps`, `cpm`, `cpc`, `cpe`, `revshare`, `hybrid`, `kpi`
`payout_calc_param`	string
`default_goal_name`	string
`destination_url`	string
`impression_url`	string
`server_side_url`	string
`view_through_destination_url`	string
`fallback_url`	string
`fallback_offer_id`	string
`is_allow_deep_link`	boolean
`deep_link_allowed_domains`	array of string
`tracking_domain_id`	string
`conversion_tracking_domain_id`	string
`is_use_secure_link`	boolean
`redirect_mode`	enum: `http302`, `http302_hide_referrer`, `http200_js`, `http200_js_hide_referrer`, `meta_refresh_single`, `meta_refresh_double`, `seo_friendly_301`, `direct_link`, `interstitial`, `app_store_smart`
`max_hops`	integer
`allowed_tracking_link_format`	enum: `numeric_id`, `unique_id`, `both`
`conversion_method`	enum: `server_postback`, `image_pixel`, `iframe_pixel`, `javascript_sdk`, `cookie_based`, `gtm`, `shopify`, `s2s_event_api`, `coupon_code`, `call`
`is_whitelist_check_enabled`	boolean
`session_definition`	enum: `cookie`, `ip`, `ip_user_agent`, `gaid`, `idfa`, `click_id_only`
`session_duration_hours`	integer
`unique_click_session_hours`	integer
`duplicate_click_action`	enum: `count`, `block`, `fail_traffic`
`already_converted_action`	enum: `allow`, `block`, `fail_traffic`
`attribution_method`	enum: `last_touch`, `first_touch`, `linear`, `position_based`, `time_decay`
`attribution_priority`	array of enum: `click_id`, `cookie`, `fingerprint`, `email`, `coupon`	WP-80: matching order for this offer's conversions; empty = default ladder (click_id, cookie, coupon; fingerprint and email off)
`sku_payouts`	array of object	WP-80: per-SKU payout / revenue per line item (flat per unit or percent of the line amount); a conversion carrying SKU lines is priced as the sum of its lines
`ctit_min_seconds`	integer
`ctit_max_hours`	integer
`is_view_through_enabled`	boolean
`view_through_lifespan_minutes`	integer
`view_through_min_seconds`	integer
`allow_impressions`	boolean
`email_attribution`	object (free-form)	enabled, method, window_minutes, window_type
`track_multi_conversions`	boolean
`is_allow_duplicate_conversion`	boolean
`is_must_approve_conversion`	boolean
`default_conversion_status`	enum: `approved`, `pending`
`allow_spillover_conversions`	boolean
`cancel_fallback_conversions`	boolean
`cancel_blocked_postback_conversions`	boolean
`scrub`	object (free-form)	enabled, percentage, status pending\|rejected
`is_caps_enabled`	boolean
`caps`	object (free-form)	daily/weekly/monthly/global x conversion/payout/revenue/click, is_soft_cap, timezone
`partner_controls`	object (free-form)	blocked_partner_ids, allowed_partner_ids, subids_blocked, subids_allowed, blacklist_postback_partners, whitelist_postback_partners, source_names, application_questionnaire_id
`email_compliance`	object (free-form)
`integrations`	object (free-form)
`terms`	object (free-form)	text, is_explicit, is_force
`kpi_requirements`	array of object (free-form)
`required_tracking_parameters`	array of object (free-form)
`localized_descriptions`	object (free-form)
`flow`	array of object (free-form)
`account_manager_id`	string
`sales_manager_id`	string

OfferWizardRequest

offer {OfferCreate}, goal {name, key, is_base_conversion}, payout {PayoutEntryCreate}

Type: object (free-form)

OfferWizardResult

the offer with goals[] and payouts[]

Type: object (free-form)

Ok

Field	Type	Flags	Description
`ok`	boolean

OperatorAccount

Field	Type	Flags	Description
`id`	string
`email`	string
`name`	string
`role`	enum: `super_admin`, `support`, `billing`, `viewer`
`status`	enum: `invited`, `active`, `disabled`
`mfa_enabled`	boolean
`last_login_at`	string (date-time)
`active_sessions`	integer
`is_me`	boolean

OperatorAccountList

Field	Type	Flags	Description
`data`	array of OperatorAccount
`roles`	array of string

OperatorAccountPatch

Field	Type	Flags
`role`	string
`name`	string
`reason`	string	required

OperatorClose

Field	Type	Flags	Description
`reason`	string	required
`confirm_slug`	string	required

OperatorDataHealth

Field	Type	Description
`checks`	array of object (free-form)
`failing_networks`	array of object (free-form)
`networks_audited`	integer
`last_pass`	object (free-form)	hourly, daily

OperatorEnroll

Field	Type	Flags	Description
`enroll_token`	string	required

OperatorEnrollConfirm

Field	Type	Flags	Description
`enroll_token`	string	required
`code`	string	required

OperatorEnrollSecret

Field	Type	Flags	Description
`secret`	string
`otpauth_uri`	string
`qr_png_base64`	string

OperatorImpersonate

Field	Type	Flags
`reason`	string	required
`minutes`	integer
`user_id`	string
`portal`	enum: `admin`, `partner`, `advertiser`
`party_id`	string
`read_only`	boolean

OperatorImpersonation

Field	Type	Flags	Description
`redirect`	string
`url`	string
`portal`	string
`tenant_slug`	string
`user_email`	string
`expires_at`	string (date-time)
`minutes`	integer
`read_only`	boolean

OperatorInvite

Field	Type	Flags
`email`	string (email)	required
`name`	string
`role`	enum: `super_admin`, `support`, `billing`, `viewer`	required
`reason`	string	required

OperatorList

Field	Type	Flags	Description
`data`	array of object (free-form)
`page`	object (free-form)

OperatorLogin

Field	Type	Flags	Description
`email`	string	required
`password`	string	required

OperatorLoginStep

Next sign-in step: TOTP (mfa_token) or first-time enrolment (enroll_token)

Field	Type	Flags	Description
`mfa_required`	boolean
`mfa_token`	string
`mfa_enrollment_required`	boolean
`enroll_token`	string

OperatorMFA

Field	Type	Flags	Description
`mfa_token`	string	required
`code`	string	required

OperatorMe

Field	Type	Flags	Description
`id`	string
`email`	string
`name`	string
`role`	enum: `super_admin`, `support`, `billing`, `viewer`
`mfa`	boolean
`session_expires_at`	string (date-time)
`last_login_at`	string (date-time)
`permissions`	array of string

OperatorPurge

Field	Type	Flags	Description
`purged`	string
`rows`	object (free-form)
`users_removed`	integer

OperatorRestore

Field	Type	Flags	Description
`reason`	string	required
`status`	enum: `active`, `trial`

OperatorSession

Field	Type	Flags	Description
`ok`	boolean
`operator`	object (free-form)		id, email, name, role

OperatorSubscriptionPatch

Field	Type	Flags
`plan`	string
`limits`	object (free-form)
`click_overage`	enum: `allow`, `block`
`status`	enum: `trial`, `active`
`trial_ends_at`	string
`billing_email`	string
`notes`	string
`reason`	string	required

OperatorSuspend

Field	Type	Flags	Description
`reason`	string	required
`block_traffic`	boolean

OperatorTenant

A workspace as the operator sees it (counts only, no tenant data)

Field	Type	Description
`id`	string
`slug`	string
`name`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`plan`	string
`modes`	array of string
`data_region`	string
`created_at`	string (date-time)
`trial_ends_at`	string (date-time)
`limits`	object (free-form)	clicks_per_month, seats, domains (absent = unlimited)
`click_overage`	enum: `allow`, `block`
`traffic_blocked`	boolean
`billing_provider`	enum: `manual`
`billing_email`	string
`status_reason`	string
`notes`	string
`usage`	object (free-form)	seats, pending_invites, domains, partners, advertisers, offers, clicks_month, last_login_at, owner_email

OperatorTenantDetail

Field	Type	Description
`tenant`	OperatorTenant	A workspace as the operator sees it (counts only, no tenant data)
`employees`	array of object (free-form)
`usage_months`	array of object (free-form)
`billing_events`	array of object (free-form)
`audit`	array of object (free-form)
`portal_hosts`	object (free-form)

OperatorTenantList

Field	Type	Description
`data`	array of OperatorTenant
`page`	object (free-form)
`status_counts`	object (free-form)
`test_tenants`	integer	live throwaway Go-test tenants the default list hides

OrgAccounts

Field	Type	Flags	Description
`current`	string
`data`	array of object (free-form)

OrgAdminAction

Field	Type	Flags	Description
`reason`	string	required
`role`	enum: `owner`, `admin`, `viewer`

OrgAdminInvite

Field	Type	Flags
`email`	string (email)	required
`name`	string
`role`	enum: `owner`, `admin`, `viewer`
`reason`	string	required

OrgAdminInvited

Field	Type	Flags	Description
`id`	string
`email`	string
`role`	string
`status`	string

OrgAdminList

Field	Type	Flags	Description
`data`	array of object (free-form)
`roles`	array of string

OrgAuthConfig

Field	Type	Flags	Description
`self_signup`	boolean
`mfa_required`	boolean

OrgInviteInfo

Field	Type	Flags	Description
`email`	string
`organization`	string
`existing_login`	boolean

OrgInviteInfoRequest

Field	Type	Flags	Description
`token`	string	required

OrgMe

Field	Type	Description
`id`	string
`email`	string
`name`	string
`role`	enum: `owner`, `admin`, `viewer`
`permissions`	array of string
`organization`	object (free-form)	id, name, slug, limits, settings
`session_expires_at`	string (date-time)

OrgNetwork

Field	Type	Description
`id`	string
`slug`	string
`name`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`plan`	string
`modes`	array of string
`created_at`	string (date-time)
`usage`	object (free-form)	seats, pending_invites, domains, partners, advertisers, offers, clicks_month, last_login_at, owner_email

OrgNetworkClosed

Field	Type	Flags	Description
`id`	string
`status`	string
`sessions_revoked`	integer

OrgNetworkCreated

Field	Type	Flags	Description
`network`	OrgNetwork
`owner_invited`	string

OrgNetworkList

Field	Type	Flags	Description
`data`	array of OrgNetwork
`limits`	object (free-form)
`settings`	object (free-form)

OrgSession

Field	Type	Flags	Description
`ok`	boolean
`org_admin`	object (free-form)		id, email, name, role

OrgSwitch

Field	Type	Flags	Description
`organization_id`	string	required

OrgSwitched

Field	Type	Flags	Description
`ok`	boolean
`organization_id`	string
`organization`	string
`role`	string

OrgUsage

Field	Type	Flags	Description
`limits`	object (free-form)
`usage`	object (free-form)		networks, seats, clicks_month, partners

Organization

Field	Type	Description
`id`	string
`slug`	string
`name`	string
`status`	enum: `active`, `suspended`, `closed`
`limits`	object (free-form)	networks (absent = unlimited)
`settings`	object (free-form)	allow_close_networks
`notes`	string
`billing_email`	string
`created_at`	string (date-time)
`networks`	integer
`admins`	integer

OrganizationAssign

Field	Type	Flags	Description
`tenant_id`	string	required
`reason`	string	required

OrganizationDetail

Field	Type	Flags	Description
`organization`	Organization
`networks`	array of OperatorTenant
`admins`	array of object (free-form)
`audit`	array of object (free-form)

OrganizationList

Field	Type	Flags	Description
`data`	array of Organization
`page`	object (free-form)

OrganizationPurged

Field	Type	Flags	Description
`purged`	string

OrganizationWrite

Field	Type	Flags
`name`	string
`slug`	string
`status`	enum: `active`, `suspended`, `closed`
`limits`	object (free-form)
`settings`	object (free-form)
`notes`	string
`billing_email`	string
`owner_email`	string
`owner_name`	string
`reason`	string	required

Page

Field	Type	Flags	Description
`page`	integer
`page_size`	integer
`total`	integer
`next_cursor`	string

Partner

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`company`	string
`username`	string
`status`	enum: `active`, `pending`, `paused`, `inactive`, `suspended`, `rejected`, `disabled`
`tags`	array of string
`account_manager_id`	string
`account_executive_id`	string
`tier_id`	string
`referrer_partner_id`	string
`traffic_source_id`	string
`business_unit_id`	string
`internal_notes`	string
`is_demo`	boolean
`contact`	object (free-form)		email, phone, website, instant_messaging{type,id}, address{...}, region{currency,lang,country}
`tracking`	object (free-form)		default_tracking_domain_id, macro_defaults{sub1..sub10,source,app_name,app_id,gaid}, enable_media_cost_tracking_links, blocked_sources[], whitelisted_advertiser_ids[], allowed_tracking_link_format, postback_whitelist_ips[], can_see_advertiser_names
`conversions_pending_default`	boolean
`visibility_overrides`	object (free-form)		adv1..adv10, sale_amount -> bool
`billing`	object (free-form)		currency, billing_frequency, billing_details{day_of_week,day_of_month_one,day_of_month_two,day_of_month,starting_month}, payment_method, payment_details{...}, tax_id, tax_form{type,status,file_ref}, is_invoice_creation_auto, auto_invoice_start_date, default_invoice_is_hidden, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, payment_hold{on,reason}, vat_rate, reverse_charge
`compliance`	object (free-form)		accepted_terms_version, accepted_terms_at, kyc_status, risk_score
`signup_ip`	string	read-only
`signup_answers`	object (free-form)
`last_login_at`	string (date-time)	read-only

PartnerApplication

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`offer_id`	string
`questionnaire_answers`	object (free-form)
`status`	enum: `pending`, `approved`, `rejected`
`reviewed_by`	string	read-only
`reviewed_at`	string (date-time)	read-only
`reason`	string

PartnerApplicationCreate

Field	Type	Flags	Description
`partner_id`	string
`offer_id`	string
`questionnaire_answers`	object (free-form)
`status`	enum: `pending`, `approved`, `rejected`
`reason`	string

PartnerApplicationDecision

decision (or status) approved|rejected; reason optional

Field	Type	Description
`decision`	enum: `approved`, `rejected`
`status`	enum: `approved`, `rejected`	alias of decision
`reason`	string

PartnerApplicationList

Field	Type	Flags	Description
`data`	array of PartnerApplication	required
`page`	Page	required

PartnerApplicationUpdate

Field	Type	Flags	Description
`partner_id`	string
`offer_id`	string
`questionnaire_answers`	object (free-form)
`status`	enum: `pending`, `approved`, `rejected`
`reason`	string

PartnerBanner

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`title`	string
`body`	string
`severity`	enum: `info`, `success`, `warning`, `critical`
`starts_at`	string (date-time)
`ends_at`	string (date-time)
`audience_id`	string
`dismissible`	boolean
`status`	enum: `active`, `paused`

PartnerBannerCreate

Field	Type	Flags
`title`	string	required
`body`	string
`severity`	enum: `info`, `success`, `warning`, `critical`
`starts_at`	string (date-time)
`ends_at`	string (date-time)
`audience_id`	string
`dismissible`	boolean
`status`	enum: `active`, `paused`

PartnerBannerList

Field	Type	Flags	Description
`data`	array of PartnerBanner	required
`page`	Page	required

PartnerBannerUpdate

Field	Type	Flags	Description
`title`	string
`body`	string
`severity`	enum: `info`, `success`, `warning`, `critical`
`starts_at`	string (date-time)
`ends_at`	string (date-time)
`audience_id`	string
`dismissible`	boolean
`status`	enum: `active`, `paused`

PartnerClickPage

rows[], has_more, next_cursor

Type: object (free-form)

PartnerCreate

Field	Type	Flags	Description
`name`	string	required
`company`	string
`username`	string
`status`	enum: `active`, `pending`, `paused`, `inactive`, `suspended`, `rejected`, `disabled`
`tags`	array of string
`account_manager_id`	string
`account_executive_id`	string
`tier_id`	string
`referrer_partner_id`	string
`traffic_source_id`	string
`business_unit_id`	string
`internal_notes`	string
`is_demo`	boolean
`contact`	object (free-form)		email, phone, website, instant_messaging{type,id}, address{...}, region{currency,lang,country}
`tracking`	object (free-form)		default_tracking_domain_id, macro_defaults{sub1..sub10,source,app_name,app_id,gaid}, enable_media_cost_tracking_links, blocked_sources[], whitelisted_advertiser_ids[], allowed_tracking_link_format, postback_whitelist_ips[], can_see_advertiser_names
`conversions_pending_default`	boolean
`visibility_overrides`	object (free-form)		adv1..adv10, sale_amount -> bool
`billing`	object (free-form)		currency, billing_frequency, billing_details{day_of_week,day_of_month_one,day_of_month_two,day_of_month,starting_month}, payment_method, payment_details{...}, tax_id, tax_form{type,status,file_ref}, is_invoice_creation_auto, auto_invoice_start_date, default_invoice_is_hidden, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, payment_hold{on,reason}, vat_rate, reverse_charge
`compliance`	object (free-form)		accepted_terms_version, accepted_terms_at, kyc_status, risk_score
`signup_answers`	object (free-form)

PartnerList

Field	Type	Flags	Description
`data`	array of Partner	required
`page`	Page	required

PartnerMMPTemplateList

Field	Type	Flags	Description
`data`	array of object (free-form)

PartnerOfferDetails

offer, payouts[], caps[] {period, limit, used, left}, restrictions, landing_pages[], application, questions[], similar[], schedule

Type: object (free-form)

PartnerOfferSearch

Type: object (free-form)

PartnerOfferSearchResult

data[] (offer, payout summary, my status, EPC and CR of the last 30 days, network EPC when the tenant shows it), facets {key: [{value, count}]}, page {page, page_size, total}, network_epc

Type: object (free-form)

PartnerOfferSetting

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string	read-only
`offer_id`	string	read-only
`access_status`	enum: `requested`, `approved`, `denied`, `blocked`
`custom_scrub`	object (free-form)		percentage, status
`custom_tracking_domain_id`	string
`visibility_override`	string
`pixel_whitelist`	array of string
`notes`	string
`payout_entries`	array of PayoutRevenueEntry
`caps`	array of Cap

PartnerOfferSettingList

Field	Type	Flags	Description
`data`	array of PartnerOfferSetting	required
`page`	Page	required

PartnerOfferSettingUpdate

Field	Type	Description
`access_status`	enum: `requested`, `approved`, `denied`, `blocked`
`custom_scrub`	object (free-form)	percentage, status
`custom_tracking_domain_id`	string
`visibility_override`	string
`pixel_whitelist`	array of string
`notes`	string
`payout_entries`	array of PayoutRevenueEntry
`caps`	array of Cap

PartnerPreferences

timezone, notifications {offer_updates, application_decisions, payments, statements, postback_failures, weekly_summary}

Type: object (free-form)

PartnerProductFeed

Field	Type	Flags	Description
`id`	string
`name`	string
`description`	string
`offer_id`	string
`offer_name`	string
`advertiser_name`	string
`row_count`	integer
`columns`	array of string
`tracking_links`	boolean
`updated_at`	string (date-time)

PartnerProductFeedList

Field	Type	Flags	Description
`data`	array of PartnerProductFeed

PartnerProgrammes

calls, leads, igaming, apps (booleans)

Type: object (free-form)

PartnerSmartlink

A smartlink the partner may run (open to partners or listing it; never one that blocks it)

Field	Type	Description
`id`	string
`display_id`	integer
`name`	string
`description`	string
`event`	enum: `click`, `impression`
`categories`	array of string
`tags`	array of string
`offer_count`	integer	active member offers
`created_at`	string (date-time)

PartnerSmartlinkLink

Field	Type	Flags	Description
`url`	string
`smartlink_id`	string
`name`	string
`qr_png_base64`	string
`qr_data_url`	string

PartnerSmartlinkLinkRequest

Field	Type	Description
`params`	object (free-form)	sub1..sub10, source, sub_source, gaid, idfa, aff_click_id, deep_link, creative_id
`style`	enum: `native`, `query`
`with_qr`	boolean

PartnerSmartlinkList

Field	Type	Flags	Description
`data`	array of PartnerSmartlink
`has_more`	boolean

PartnerTier

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`description`	string
`payout_multiplier`	string		decimal string
`auto_tier_rules`	array of object (free-form)
`rank`	integer
`commission_mode`	enum: `multiplier`, `absolute`
`commission_amount`	string		decimal string
`hysteresis_percent`	string		decimal string
`min_days_in_tier`	integer
`referral_percent`	string		decimal string
`benefits`	string
`status`	string

PartnerTierCreate

Field	Type	Flags	Description
`name`	string	required
`description`	string
`payout_multiplier`	string		decimal string
`auto_tier_rules`	array of object (free-form)
`rank`	integer
`commission_mode`	enum: `multiplier`, `absolute`
`commission_amount`	string		decimal string
`hysteresis_percent`	string		decimal string
`min_days_in_tier`	integer
`referral_percent`	string		decimal string
`benefits`	string
`status`	string

PartnerTierList

Field	Type	Flags	Description
`data`	array of PartnerTier	required
`page`	Page	required

PartnerTierRule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`tier_id`	string
`metric`	enum: `conversions`, `approved_conversions`, `revenue`, `payout`, `sale_amount`, `cr`, `clicks`
`window_days`	integer
`min_value`	string		decimal string
`status`	string

PartnerTierRuleCreate

Field	Type	Flags	Description
`tier_id`	string	required
`metric`	enum: `conversions`, `approved_conversions`, `revenue`, `payout`, `sale_amount`, `cr`, `clicks`	required
`window_days`	integer
`min_value`	string		decimal string
`status`	string

PartnerTierRuleList

Field	Type	Flags	Description
`data`	array of PartnerTierRule	required
`page`	Page	required

PartnerTierRuleUpdate

Field	Type	Description
`tier_id`	string
`metric`	enum: `conversions`, `approved_conversions`, `revenue`, `payout`, `sale_amount`, `cr`, `clicks`
`window_days`	integer
`min_value`	string	decimal string
`status`	string

PartnerTierUpdate

Field	Type	Description
`name`	string
`description`	string
`payout_multiplier`	string	decimal string
`auto_tier_rules`	array of object (free-form)
`rank`	integer
`commission_mode`	enum: `multiplier`, `absolute`
`commission_amount`	string	decimal string
`hysteresis_percent`	string	decimal string
`min_days_in_tier`	integer
`referral_percent`	string	decimal string
`benefits`	string
`status`	string

PartnerUpdate

Field	Type	Description
`name`	string
`company`	string
`username`	string
`status`	enum: `active`, `pending`, `paused`, `inactive`, `suspended`, `rejected`, `disabled`
`tags`	array of string
`account_manager_id`	string
`account_executive_id`	string
`tier_id`	string
`referrer_partner_id`	string
`traffic_source_id`	string
`business_unit_id`	string
`internal_notes`	string
`is_demo`	boolean
`contact`	object (free-form)	email, phone, website, instant_messaging{type,id}, address{...}, region{currency,lang,country}
`tracking`	object (free-form)	default_tracking_domain_id, macro_defaults{sub1..sub10,source,app_name,app_id,gaid}, enable_media_cost_tracking_links, blocked_sources[], whitelisted_advertiser_ids[], allowed_tracking_link_format, postback_whitelist_ips[], can_see_advertiser_names
`conversions_pending_default`	boolean
`visibility_overrides`	object (free-form)	adv1..adv10, sale_amount -> bool
`billing`	object (free-form)	currency, billing_frequency, billing_details{day_of_week,day_of_month_one,day_of_month_two,day_of_month,starting_month}, payment_method, payment_details{...}, tax_id, tax_form{type,status,file_ref}, is_invoice_creation_auto, auto_invoice_start_date, default_invoice_is_hidden, invoice_generation_days_delay, invoice_amount_threshold, default_payment_terms, payment_hold{on,reason}, vat_rate, reverse_charge
`compliance`	object (free-form)	accepted_terms_version, accepted_terms_at, kyc_status, risk_score
`signup_answers`	object (free-form)

PaymentMethod

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`type`	enum: `paypal`, `payoneer`, `tipalti`, `wise`, `stripe`, `crypto`, `sepa`, `ach`, `india_bank`, `wire`, `manual`
`currency`	string
`label`	string
`details`	object (free-form)		type-specific, write-only: paypal email \| payoneer/tipalti payee_id \| wise recipient_id \| stripe account_id \| crypto address+network \| sepa iban(+bic) \| ach routing+account \| india_bank account+ifsc
`details_hint`	string	read-only
`is_default`	boolean
`verified_at`	string (date-time)	read-only

PaymentMethodCreate

Field	Type	Flags	Description
`partner_id`	string	required
`type`	enum: `paypal`, `payoneer`, `tipalti`, `wise`, `stripe`, `crypto`, `sepa`, `ach`, `india_bank`, `wire`, `manual`	required
`currency`	string
`label`	string
`details`	object (free-form)		type-specific, write-only: paypal email \| payoneer/tipalti payee_id \| wise recipient_id \| stripe account_id \| crypto address+network \| sepa iban(+bic) \| ach routing+account \| india_bank account+ifsc
`is_default`	boolean

PaymentMethodDefault

id, partner_id, is_default

Type: object (free-form)

PayoutOverride

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`offer_id`	string
`goal_id`	string
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`device_types`	array of string
`os`	array of string
`variable`	string
`allowed_values`	array of string
`skus`	array of string
`product_categories`	array of string
`date_valid_from`	string (date-time)
`date_valid_to`	string (date-time)
`hours_of_day`	array of integer
`days_of_week`	array of integer
`timezone`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`payout_amount`	string		decimal string
`payout_percentage`	string		decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`revenue_amount`	string		decimal string
`revenue_percentage`	string		decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`priority`	integer
`status`	string
`description`	string

PayoutOverrideCreate

Field	Type	Flags	Description
`name`	string	required
`offer_id`	string
`goal_id`	string
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`device_types`	array of string
`os`	array of string
`variable`	string
`allowed_values`	array of string
`skus`	array of string
`product_categories`	array of string
`date_valid_from`	string (date-time)
`date_valid_to`	string (date-time)
`hours_of_day`	array of integer
`days_of_week`	array of integer
`timezone`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`payout_amount`	string		decimal string
`payout_percentage`	string		decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`revenue_amount`	string		decimal string
`revenue_percentage`	string		decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`priority`	integer
`status`	string
`description`	string

PayoutOverrideList

Field	Type	Flags	Description
`data`	array of PayoutOverride	required
`page`	Page	required

PayoutOverrideUpdate

Field	Type	Description
`name`	string
`offer_id`	string
`goal_id`	string
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`device_types`	array of string
`os`	array of string
`variable`	string
`allowed_values`	array of string
`skus`	array of string
`product_categories`	array of string
`date_valid_from`	string (date-time)
`date_valid_to`	string (date-time)
`hours_of_day`	array of integer
`days_of_week`	array of integer
`timezone`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`priority`	integer
`status`	string
`description`	string

PayoutRevenueEntry

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`offer_id`	string	read-only
`goal_id`	string
`entry_name`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`payout_amount`	string		decimal string
`payout_percentage`	string		decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`revenue_amount`	string		decimal string
`revenue_percentage`	string		decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`tier_metric`	enum: `conversions`, `revenue`, `sales`, `ftd`
`tier_period`	enum: `month`, `lifetime`
`tier_apply_to`	enum: `partner`, `tier`
`is_default`	boolean
`is_private`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve_conversion`	boolean
`is_allow_duplicate_conversion`	boolean
`is_apply_all_partners`	boolean
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`city`	array of string
`landing_page_ids`	array of string
`variable`	string
`allowed_values`	array of string
`rule_set_id`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`priority`	integer
`description`	string
`public_description`	string
`status`	enum: `active`, `inactive`

PayoutRevenueEntryCreate

Field	Type	Description
`goal_id`	string
`entry_name`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`tier_metric`	enum: `conversions`, `revenue`, `sales`, `ftd`
`tier_period`	enum: `month`, `lifetime`
`tier_apply_to`	enum: `partner`, `tier`
`is_default`	boolean
`is_private`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve_conversion`	boolean
`is_allow_duplicate_conversion`	boolean
`is_apply_all_partners`	boolean
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`city`	array of string
`landing_page_ids`	array of string
`variable`	string
`allowed_values`	array of string
`rule_set_id`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`priority`	integer
`description`	string
`public_description`	string
`status`	enum: `active`, `inactive`

PayoutRevenueEntryList

Field	Type	Flags	Description
`data`	array of PayoutRevenueEntry	required
`page`	Page	required

PayoutRevenueEntryUpdate

Field	Type	Description
`goal_id`	string
`entry_name`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`tier_metric`	enum: `conversions`, `revenue`, `sales`, `ftd`
`tier_period`	enum: `month`, `lifetime`
`tier_apply_to`	enum: `partner`, `tier`
`is_default`	boolean
`is_private`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve_conversion`	boolean
`is_allow_duplicate_conversion`	boolean
`is_apply_all_partners`	boolean
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`city`	array of string
`landing_page_ids`	array of string
`variable`	string
`allowed_values`	array of string
`rule_set_id`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`priority`	integer
`description`	string
`public_description`	string
`status`	enum: `active`, `inactive`

PayoutRun

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`rail`	enum: `none`, `paypal`, `check`, `wire`, `direct_deposit`, `tipalti`, `paxum`, `veem`, `payoneer`, `bitcoin`, `usdt`, `webmoney`, ...
`currency`	string
`statement_ids`	array of string
`total`	string		decimal string
`fees`	string		decimal string
`status`	enum: `draft`, `pending_approval`, `approved`, `executing`, `done`, `failed`, `cancelled`
`items`	array of object (free-form)
`approved_by`	string
`executed_at`	string (date-time)

PayoutRunCreate

Field	Type	Flags	Description
`statement_ids`	array of string	required
`rail`	string		default wire
`name`	string
`currency`	string

PayoutScrubRule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`offer_id`	string
`goal_id`	string
`percentage`	string		decimal string
`to_status`	enum: `pending`, `rejected`, `scrubbed`
`zero_payout`	boolean
`status`	string
`description`	string

PayoutScrubRuleCreate

Field	Type	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`percentage`	string	decimal string
`to_status`	enum: `pending`, `rejected`, `scrubbed`
`zero_payout`	boolean
`status`	string
`description`	string

PayoutScrubRuleList

Field	Type	Flags	Description
`data`	array of PayoutScrubRule	required
`page`	Page	required

PayoutScrubRuleUpdate

Field	Type	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`percentage`	string	decimal string
`to_status`	enum: `pending`, `rejected`, `scrubbed`
`zero_payout`	boolean
`status`	string
`description`	string

PdfFile

binary application/pdf

Type: object (free-form)

PeopleAction

Field	Type	Flags
`principal_type`	enum: `employee`, `partner`, `advertiser`
`party_id`	string
`reason`	string	required
`role_key`	string

PeopleActionResult

Field	Type	Flags	Description
`user_id`	string
`email`	string
`status`	string
`sessions_revoked`	integer
`keys_revoked`	integer

PeopleInvite

Field	Type	Flags	Description
`email`	string (email)	required
`name`	string
`role_key`	string		staff role key, default admin
`reason`	string	required

PeopleInvited

Field	Type	Flags	Description
`invitation_id`	string
`email`	string
`role_key`	string

PlatformDashboard

Field	Type	Description
`networks`	integer
`status_counts`	object (free-form)
`organizations`	integer
`signups`	object (free-form)
`growth`	array of object (free-form)
`traffic`	RollupReport	One reporting rollup over an explicit tenant list (network audience)
`health`	object (free-form)

PlatformSearch

Field	Type	Flags	Description
`q`	string
`networks`	array of object (free-form)
`organizations`	array of object (free-form)
`people`	array of object (free-form)
`parties`	array of object (free-form)

PortalAccount

Field	Type	Flags	Description
`id`	string
`display_id`	integer
`name`	string
`status`	string
`role`	string

PortalAccounts

Field	Type	Description
`principal_type`	string
`current`	string
`switchable`	boolean	a session (not an API key or MCP token) with more than one account
`data`	array of PortalAccount

PortalDoc

WP-41 portal document

Type: object (free-form)

Postback

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)
`consecutive_failures`	integer	read-only
`last_fired_at`	string (date-time)	read-only
`last_error`	string	read-only

PostbackCreate

Field	Type	Flags
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string	required
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

PostbackForwardRule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`advertiser_id`	string
`offer_id`	string
`platform`	string
`url_template`	string
`method`	enum: `GET`, `POST`
`append_raw_query`	boolean
`enabled`	boolean
`max_attempts`	integer
`timeout_ms`	integer
`notes`	string

PostbackForwardRuleCreate

Field	Type	Flags
`advertiser_id`	string
`offer_id`	string
`platform`	string
`url_template`	string	required
`method`	enum: `GET`, `POST`
`append_raw_query`	boolean
`enabled`	boolean
`max_attempts`	integer
`timeout_ms`	integer
`notes`	string

PostbackForwardRuleList

Field	Type	Flags	Description
`data`	array of PostbackForwardRule	required
`page`	Page	required

PostbackForwardRuleUpdate

Field	Type	Flags	Description
`advertiser_id`	string
`offer_id`	string
`platform`	string
`url_template`	string
`method`	enum: `GET`, `POST`
`append_raw_query`	boolean
`enabled`	boolean
`max_attempts`	integer
`timeout_ms`	integer
`notes`	string

PostbackList

Field	Type	Flags	Description
`data`	array of Postback	required
`page`	Page	required

PostbackSetup

WP-80: an advertiser's postback, reversal and MMP setup

Field	Type	Flags	Description
`tracking_base`	string
`token_secured`	boolean
`postback_url`	string
`reversal_url`	string
`mmp`	array of object (free-form)

PostbackTestRequest

Field	Type	Flags	Description
`params`	object (free-form)	required	Postback parameters (at least click_id or txn_id; goal, amount, currency, security_token ...); sent to ingest with test=1

PostbackToken

postback_token, rotated_at, message

Type: object (free-form)

PostbackUpdate

Field	Type	Flags	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

ProductFeed

Field	Type	Flags	Description
`id`	string
`name`	string
`description`	string
`advertiser_id`	string
`offer_id`	string
`visibility`	enum: `all`, `approved`
`status`	enum: `active`, `paused`
`file_name`	string
`row_count`	integer
`columns`	array of string
`url_column`	string
`size_bytes`	integer
`created_at`	string (date-time)
`updated_at`	string (date-time)

ProductFeedList

Field	Type	Flags	Description
`data`	array of ProductFeed

ProductFeedWrite

Field	Type	Description
`name`	string
`description`	string
`advertiser_id`	string
`offer_id`	string
`visibility`	enum: `all`, `approved`
`status`	enum: `active`, `paused`
`file_ref`	string	id from POST /files/upload (CSV with a header row; a url/product_url/link column enables partner tracking links)

ReconJob

id, status, params, counts, results[]

Type: object (free-form)

ReconJobList

rows[] of jobs, has_more

Type: object (free-form)

ReplayResult

Field	Type	Flags	Description
`replay_of`	string
`webhook_id`	string
`status`	string
`response_code`	integer
`response_body`	string
`latency_ms`	integer
`error`	string

ReportCatalog

Field	Type	Description
`principal`	enum: `network`, `partner`, `advertiser`
`endpoint`	string
`dimensions`	array of object (free-form)
`metrics`	array of object (free-form)
`groups`	array of object (free-form)
`report_presets`	array of object (free-form)
`granularities`	array of string
`filter_ops`	array of string
`metric_filter_ops`	array of string
`compare_to`	array of string
`date_basis`	array of string
`default_metrics`	array of string
`defaults`	object (free-form)	timezone, currency, date_basis of the tenant
`contract`	object (free-form)	result semantics: currency, percent, types, totals, compare, top_n, hidden_fields

ReportQuery

Field	Type	Flags	Description
`from`	string	required
`to`	string	required
`timezone`	string
`currency`	string
`granularity`	enum: `none`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
`dimensions`	array of string
`metrics`	array of string
`filters`	array of object
`metric_filters`	array of object
`sort`	array of object (free-form)
`limit`	integer
`cursor`	string
`options`	object (free-form)		remove_zero_rows, ignore_fail_traffic, only_fail_traffic, include_on_hold, status_scope, compare_to previous_period\|previous_year, attribution_date click\|conversion, date_basis conversion_date\|click_date, use_current_rates
`top_n`	integer		first N rows by the sort plus one (other) row
`view`	object (free-form)		report builder presentation state saved with a report (date preset, chart, column order); ignored by the engine
`tree`	ReportTreeSpec

ReportResult

Field	Type	Description
`columns`	array of object (free-form)
`rows`	array of array of any
`totals`	object (free-form)
`next_cursor`	string
`as_of`	string (date-time)
`query`	ReportQuery
`row_keys`	array of array of string
`compare`	object (free-form)	comparison-period totals with from/to
`compare_rows`	array of object (free-form)
`currency`	string
`totals_by_currency`	object (free-form)	money totals per original currency
`timezone`	string
`warnings`	array of string
`source`	string

ReportSchedule

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`cron`	string
`timezone`	string
`report`	object (free-form)		POST /reports/export body (query\|log); dates may use {{today}} {{yesterday}} {{7d_ago}} {{30d_ago}} {{month_start}}
`recipients`	array of string
`format`	enum: `csv`, `tsv`, `json`
`status`	enum: `active`, `paused`
`next_run_at`	string (date-time)	read-only
`last_run_at`	string (date-time)	read-only
`last_job_id`	string	read-only
`last_error`	string	read-only

ReportScheduleCreate

Field	Type	Flags	Description
`name`	string	required
`cron`	string	required
`timezone`	string
`report`	object (free-form)	required	POST /reports/export body (query\|log); dates may use {{today}} {{yesterday}} {{7d_ago}} {{30d_ago}} {{month_start}}
`recipients`	array of string
`format`	enum: `csv`, `tsv`, `json`
`status`	enum: `active`, `paused`

ReportScheduleList

Field	Type	Flags	Description
`data`	array of ReportSchedule	required
`page`	Page	required

ReportScheduleUpdate

Field	Type	Description
`name`	string
`cron`	string
`timezone`	string
`report`	object (free-form)	POST /reports/export body (query\|log); dates may use {{today}} {{yesterday}} {{7d_ago}} {{30d_ago}} {{month_start}}
`recipients`	array of string
`format`	enum: `csv`, `tsv`, `json`
`status`	enum: `active`, `paused`

ReportTree

Field	Type	Description
`mode`	enum: `tree`
`levels`	array of string
`columns`	array of object (free-form)
`node`	ReportTreeNode
`nodes`	array of ReportTreeNode	descendants of node in pre-order
`compare_range`	object (free-form)	{from, to}
`currency`	string
`timezone`	string
`warnings`	array of string
`truncated`	boolean
`queries`	integer
`as_of`	string (date-time)
`query`	object (free-form)

ReportTreeNode

Field	Type	Flags	Description
`id`	string
`depth`	integer
`level`	string
`key`	string
`label`	string
`path`	array of ReportTreeStep
`metrics`	object (free-form)		metric key -> cell (ReportResult encoding)
`compare`	object (free-form)		same metrics in the comparison period; null = no counterpart
`has_children`	boolean
`child_count`	integer	nullable
`child_count_capped`	boolean
`other`	boolean
`expanded`	boolean

ReportTreeSpec

Field	Type	Description
`levels`	array of string	1..6 dimensions, outermost first (default: the query dimensions)
`path`	array of ReportTreeStep	focus a node (path[i].dim = levels[i]); its children are returned; empty = root
`level_sort`	array of object (free-form)
`limit`	integer	children per node (default 25); the rest fold into one (other) node; time levels are never folded
`expand_depth`	integer	levels below the focused node returned in one call (default 1)
`max_nodes`	integer	node cap for expand_depth (default 2000); truncated=true when hit

ReportTreeStep

Field	Type	Flags
`dim`	string	required
`value`	string	required
`label`	string

RevsharePreview

items[] {conversion_id, partner_id, currency, old_payout, new_payout, payout_delta, old_revenue, new_revenue, revenue_delta, note restated|unchanged|missing|out_of_scope}, truncated, summary {rows, restated, unchanged, missing, payout_before, payout_after, payout_delta, revenue_before, revenue_after, revenue_delta}

Type: object (free-form)

RevsharePreviewRequest

rows[] {conversion_id, revenue, payout} + payout_percent, or run_id

Type: object (free-form)

RevshareRun

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`advertiser_id`	string
`offer_id`	string
`period_from`	string (date)
`period_to`	string (date)
`currency`	string
`rows`	array of object (free-form)
`payout_percent`	string		decimal string
`status`	enum: `pending`, `running`, `done`, `failed`	read-only
`stats`	object (free-form)
`error`	string	read-only
`started_at`	string (date-time)	read-only
`finished_at`	string (date-time)	read-only

RevshareRunCreate

Field	Type	Description
`name`	string
`advertiser_id`	string
`offer_id`	string
`period_from`	string (date)
`period_to`	string (date)
`currency`	string
`rows`	array of object (free-form)
`payout_percent`	string	decimal string
`stats`	object (free-form)

RevshareRunList

Field	Type	Flags	Description
`data`	array of RevshareRun	required
`page`	Page	required

RevshareRunUpdate

Field	Type	Description
`name`	string
`advertiser_id`	string
`offer_id`	string
`period_from`	string (date)
`period_to`	string (date)
`currency`	string
`rows`	array of object (free-form)
`payout_percent`	string	decimal string
`stats`	object (free-form)

Role

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`key`	string
`name`	string
`principal_type`	enum: `employee`, `partner_user`, `advertiser_user`
`permissions`	object (free-form)		resource -> {read,write,scope}
`is_builtin`	boolean	read-only

RoleCreate

Field	Type	Flags	Description
`key`	string	required
`name`	string	required
`principal_type`	enum: `employee`, `partner_user`, `advertiser_user`	required
`permissions`	object (free-form)		resource -> {read,write,scope}

RoleList

Field	Type	Flags	Description
`data`	array of Role	required
`page`	Page	required

RoleUpdate

Field	Type	Description
`key`	string
`name`	string
`principal_type`	enum: `employee`, `partner_user`, `advertiser_user`
`permissions`	object (free-form)	resource -> {read,write,scope}

RollupReport

One reporting rollup over an explicit tenant list (network audience)

Field	Type	Description
`totals`	object (free-form)	per currency: clicks, conversions (approved + pending), revenue, payout (approved, 6 dp), profit
`networks`	array of object (free-form)
`days`	array of object (free-form)
`from`	string
`to`	string
`network_count`	integer

RuleCatalog

Field	Type	Flags	Description
`operators`	array of object (free-form)
`variables`	array of object (free-form)
`scope_kinds`	array of string
`actions`	array of string

RuleSet

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)		target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer		WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`		WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

RuleSetCreate

Field	Type	Flags	Description
`name`	string	required
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`	required
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)		target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer		WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`		WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

RuleSetList

Field	Type	Flags	Description
`data`	array of RuleSet	required
`page`	Page	required

RuleSetUpdate

Field	Type	Description
`name`	string
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)	target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer	WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`	WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

RuleTestRequest

rules[] {variable, operator, values[], list_id}, match all|any, action, click {variable: value}

Type: object (free-form)

RuleTestResult

matched, outcome (action or pass), conditions[] {index, variable, operator, value, matched}

Type: object (free-form)

SavedListView

id, screen, name, state {filters, q, sort, columns, density...}, is_shared, is_default (personal), mine, owner_id, updated_at

Type: object (free-form)

SavedListViewList

data[] SavedListView

Type: object (free-form)

SavedListViewPatchResult

id, updated

Type: object (free-form)

SavedReport

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`query`	ReportQuery
`is_shared`	boolean
`description`	string
`visibility`	enum: `private`, `team`
`pinned`	boolean
`owner_user_id`	string	read-only
`principal_type`	enum: `network`, `partner`, `advertiser`	read-only

SavedReportList

Field	Type	Flags	Description
`rows`	array of SavedReport
`has_more`	boolean

ScheduledAction

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`entity_type`	enum: `offer`, `partner`, `advertiser`, `smartlink`, `cap`, `payout_entry`, `partner_offer_setting`
`entity_id`	string
`action`	enum: `set_status`, `set_cap`, `set_payout`, `set_access`
`params`	object (free-form)		set_status {status}; set_cap {hourly,daily,weekly,monthly,lifetime,is_soft_cap,status}; set_payout {payout_amount,revenue_amount}; set_access {access_status}
`run_at`	string (date-time)
`status`	enum: `scheduled`, `running`, `done`, `failed`, `cancelled`	read-only
`result`	string	read-only
`executed_at`	string (date-time)	read-only
`attempts`	integer	read-only
`created_by`	string	read-only

ScheduledActionCreate

Field	Type	Flags	Description
`name`	string
`entity_type`	enum: `offer`, `partner`, `advertiser`, `smartlink`, `cap`, `payout_entry`, `partner_offer_setting`	required
`entity_id`	string	required
`action`	enum: `set_status`, `set_cap`, `set_payout`, `set_access`	required
`params`	object (free-form)		set_status {status}; set_cap {hourly,daily,weekly,monthly,lifetime,is_soft_cap,status}; set_payout {payout_amount,revenue_amount}; set_access {access_status}
`run_at`	string (date-time)	required

ScheduledActionList

Field	Type	Flags	Description
`data`	array of ScheduledAction	required
`page`	Page	required

ScheduledActionUpdate

Field	Type	Description
`name`	string
`entity_type`	enum: `offer`, `partner`, `advertiser`, `smartlink`, `cap`, `payout_entry`, `partner_offer_setting`
`entity_id`	string
`action`	enum: `set_status`, `set_cap`, `set_payout`, `set_access`
`params`	object (free-form)	set_status {status}; set_cap {hourly,daily,weekly,monthly,lifetime,is_soft_cap,status}; set_payout {payout_amount,revenue_amount}; set_access {access_status}
`run_at`	string (date-time)

SearchRequest

Field	Type	Flags	Description
`filters`	array of object
`search`	string
`sort`	array of object (free-form)
`page`	integer
`page_size`	integer
`include`	array of string

SheetsSchema

Field	Type	Flags	Description
`dimensions`	array of object (free-form)
`metrics`	array of object (free-form)
`granularities`	array of string
`endpoint`	string
`auth`	string
`request_example`	object (free-form)

SignInAlerts

Field	Type	Flags	Description
`enabled`	boolean
`browsers`	array of object (free-form)

SignInAlertsUpdate

Field	Type	Flags	Description
`enabled`	boolean	required

SignupQuestion

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`portal`	enum: `partner`, `advertiser`
`key`	string
`label`	string
`help`	string
`kind`	enum: `text`, `textarea`, `select`, `multiselect`, `checkbox`, `url`, `number`
`options`	array of string
`required`	boolean
`position`	integer
`status`	enum: `active`, `archived`

SignupQuestionCreate

Field	Type	Flags
`portal`	enum: `partner`, `advertiser`
`key`	string
`label`	string	required
`help`	string
`kind`	enum: `text`, `textarea`, `select`, `multiselect`, `checkbox`, `url`, `number`
`options`	array of string
`required`	boolean
`position`	integer
`status`	enum: `active`, `archived`

SignupQuestionList

Field	Type	Flags	Description
`data`	array of SignupQuestion	required
`page`	Page	required

SignupQuestionUpdate

Field	Type	Flags	Description
`portal`	enum: `partner`, `advertiser`
`key`	string
`label`	string
`help`	string
`kind`	enum: `text`, `textarea`, `select`, `multiselect`, `checkbox`, `url`, `number`
`options`	array of string
`required`	boolean
`position`	integer
`status`	enum: `active`, `archived`

SignupVerify

token, host, tenant_slug

Type: object (free-form)

SignupVerifyResult

verified, status (pending|active)

Type: object (free-form)

SignupVerifySend

email, host, tenant_slug

Type: object (free-form)

SkanCvSchema

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`app_id`	string
`name`	string
`status`	enum: `draft`, `active`, `archived`	read-only
`currency`	string
`activated_at`	string (date-time)	read-only
`schema`	object (free-form)		SDK contract: version, windows[{window 0-2, lock_at_fine_gte, rules[{fine 0-63, coarse low\|medium\|high, lock, when{event, count_gte, revenue_gte}}]}] (sdks/test-vectors/cv-schema.json)

SkanCvSchemaCreate

Field	Type	Flags	Description
`app_id`	string	required
`name`	string	required
`currency`	string
`schema`	object (free-form)		SDK contract: version, windows[{window 0-2, lock_at_fine_gte, rules[{fine 0-63, coarse low\|medium\|high, lock, when{event, count_gte, revenue_gte}}]}] (sdks/test-vectors/cv-schema.json)

SkanCvSchemaList

Field	Type	Flags	Description
`data`	array of SkanCvSchema	required
`page`	Page	required

SkanCvSchemaUpdate

Field	Type	Description
`app_id`	string
`name`	string
`currency`	string
`schema`	object (free-form)	SDK contract: version, windows[{window 0-2, lock_at_fine_gte, rules[{fine 0-63, coarse low\|medium\|high, lock, when{event, count_gte, revenue_gte}}]}] (sdks/test-vectors/cv-schema.json)

SkanPostback

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	string
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`app_id`	string
`kind`	enum: `skan`, `aak`
`ad_network_id`	string
`transaction_id`	string
`postback_sequence_index`	integer
`source_identifier`	string
`source_app_id`	string
`source_domain`	string
`fidelity_type`	integer
`did_win`	boolean
`redownload`	boolean
`conversion_type`	string
`fine_cv`	integer
`coarse_cv`	string
`country_code`	string
`verified`	boolean
`verify_error`	string
`partner_id`	string
`offer_id`	string
`mapping_id`	string
`schema_id`	string
`campaign_name`	string
`events`	array of string
`revenue_estimate`	string		decimal string
`currency`	string
`raw`	object (free-form)
`received_at`	string (date-time)

SkanPostbackList

Field	Type	Flags	Description
`data`	array of SkanPostback	required
`page`	Page	required

SkanSourceMapping

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`app_id`	string
`ad_network_id`	string
`source_identifier`	string		SKAN 4 / AAK source identifier or SKAN <=3 campaign id; empty = network default
`source_app_id`	string
`partner_id`	string
`offer_id`	string
`campaign_name`	string
`status`	enum: `active`, `paused`

SkanSourceMappingCreate

Field	Type	Flags	Description
`app_id`	string
`ad_network_id`	string	required
`source_identifier`	string		SKAN 4 / AAK source identifier or SKAN <=3 campaign id; empty = network default
`source_app_id`	string
`partner_id`	string
`offer_id`	string
`campaign_name`	string
`status`	enum: `active`, `paused`

SkanSourceMappingList

Field	Type	Flags	Description
`data`	array of SkanSourceMapping	required
`page`	Page	required

SkanSourceMappingUpdate

Field	Type	Description
`app_id`	string
`ad_network_id`	string
`source_identifier`	string	SKAN 4 / AAK source identifier or SKAN <=3 campaign id; empty = network default
`source_app_id`	string
`partner_id`	string
`offer_id`	string
`campaign_name`	string
`status`	enum: `active`, `paused`

Smartlink

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`event`	enum: `click`, `impression`
`type`	enum: `manual`, `category`
`routing_type`	enum: `priority`, `weight`, `kpi_auto`, `round_robin`, `epc`
`lookback_hours`	integer
`kpi`	object (free-form)		metric epc\|cr, min_clicks
`offer_group_id`	string
`advertiser_ids`	array of string
`categories`	array of string
`allowed_partner_ids`	array of string
`blocked_partner_ids`	array of string
`is_open_to_partners`	boolean
`catch_all_offer_id`	string
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value
`fallback_url`	string
`targeting`	object (free-form)		geo_allow[], geo_deny[], device_types[], os[]
`append_url`	object (free-form)		key -> value
`tags`	array of string
`tracking_domain_id`	string
`is_use_secure_link`	boolean

SmartlinkCreate

Field	Type	Flags	Description
`name`	string	required
`description`	string
`status`	enum: `active`, `paused`, `archived`
`event`	enum: `click`, `impression`
`type`	enum: `manual`, `category`
`routing_type`	enum: `priority`, `weight`, `kpi_auto`, `round_robin`, `epc`
`lookback_hours`	integer
`kpi`	object (free-form)		metric epc\|cr, min_clicks
`offer_group_id`	string
`advertiser_ids`	array of string
`categories`	array of string
`allowed_partner_ids`	array of string
`blocked_partner_ids`	array of string
`is_open_to_partners`	boolean
`catch_all_offer_id`	string
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value
`fallback_url`	string
`targeting`	object (free-form)		geo_allow[], geo_deny[], device_types[], os[]
`append_url`	object (free-form)		key -> value
`tags`	array of string
`tracking_domain_id`	string
`is_use_secure_link`	boolean
`hash_id`	string

SmartlinkList

Field	Type	Flags	Description
`data`	array of Smartlink	required
`page`	Page	required

SmartlinkOffer

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`smartlink_id`	string
`offer_id`	string
`status`	enum: `active`, `paused`
`priority`	integer
`weight`	integer
`geo_allow`	array of string
`geo_deny`	array of string
`device_types`	array of string
`os`	array of string

SmartlinkOfferCreate

Field	Type	Flags
`smartlink_id`	string
`offer_id`	string	required
`status`	enum: `active`, `paused`
`priority`	integer
`weight`	integer
`geo_allow`	array of string
`geo_deny`	array of string
`device_types`	array of string
`os`	array of string

SmartlinkOfferList

Field	Type	Flags	Description
`data`	array of SmartlinkOffer	required
`page`	Page	required

SmartlinkOfferUpdate

Field	Type	Flags	Description
`smartlink_id`	string
`offer_id`	string
`status`	enum: `active`, `paused`
`priority`	integer
`weight`	integer
`geo_allow`	array of string
`geo_deny`	array of string
`device_types`	array of string
`os`	array of string

SmartlinkSimulateRequest

country (ISO2), device, os, partner_id, clicks (1-1000, default 100)

Type: object (free-form)

SmartlinkSimulateResult

serving, reason, routing_type, clicks, members[] {offer_id, offer_name, priority, weight, eligible, reason (geo|device|os|offer_inactive|offer_scheduled|partner_blocked|duplicate), clicks, share}, catch_all, no_offer, notes[]

Type: object (free-form)

SmartlinkUpdate

Field	Type	Description
`name`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`event`	enum: `click`, `impression`
`type`	enum: `manual`, `category`
`routing_type`	enum: `priority`, `weight`, `kpi_auto`, `round_robin`, `epc`
`lookback_hours`	integer
`kpi`	object (free-form)	metric epc\|cr, min_clicks
`offer_group_id`	string
`advertiser_ids`	array of string
`categories`	array of string
`allowed_partner_ids`	array of string
`blocked_partner_ids`	array of string
`is_open_to_partners`	boolean
`catch_all_offer_id`	string
`fail_traffic_target`	object (free-form)	type offer\|offer_url\|offer_group\|smartlink, routing_value
`fallback_url`	string
`targeting`	object (free-form)	geo_allow[], geo_deny[], device_types[], os[]
`append_url`	object (free-form)	key -> value
`tags`	array of string
`tracking_domain_id`	string
`is_use_secure_link`	boolean
`hash_id`	string

Statement

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string
`number`	string
`period_from`	string (date)
`period_to`	string (date)
`currency`	string
`subtotal`	string		decimal string
`tax`	string		decimal string
`tax_rule`	string
`withholding`	string		decimal string
`total`	string		decimal string
`status`	enum: `draft`, `approved`, `sent`, `partially_paid`, `paid`, `void`
`payment_status`	enum: `not_initiated`, `in_progress`, `complete`, `failed`
`due_on`	string (date)
`lines`	array of object (free-form)
`adjustments`	array of object (free-form)
`paid_at`	string (date-time)
`pdf_ref`	string

StatementGenerateRequest

Field	Type	Flags	Description
`period_from`	string (date)	required
`period_to`	string (date)	required
`partner_ids`	array of string
`partner_id`	string
`currency`	string
`net_terms`	integer
`threshold`	string		money; partners below it are skipped
`basis`	string

StatementGenerateResult

created[] (statements), skipped[] {partner_id, currency, reason}, created_count, skipped_count

Type: object (free-form)

StatementSearchResult

data[] statements with partner_name, overdue, conversion_count; page {page, page_size, total}; has_more

Type: object (free-form)

StatusDoc

WP-37 status/health document (components, incidents, updates, maintenance, subscribers, synthetic results)

Type: object (free-form)

SwitchAccountRequest

Field	Type	Flags	Description
`account_id`	string	required	account id or display id

SwitchAccountResult

Field	Type	Flags	Description
`current`	string
`account`	PortalAccount

TaxForm

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`partner_id`	string	read-only
`form_type`	enum: `w9`, `w8ben`, `w8bene`
`status`	enum: `pending`, `verified`, `rejected`, `expired`	read-only
`fields`	object (free-form)		legal_name, country, tin, tin_type, address{street,city,region,postal}, treaty_country, vat_number, gstin, signature_name, signed_on
`file_name`	string	read-only
`withholding_pct`	string	read-only	decimal string
`withholding_reason`	string	read-only
`expires_at`	string (date-time)	read-only

TeamInvitation

id, email, status

Type: object (free-form)

TeamMemberPatch

Type: object (free-form)

Tenant

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`slug`	string
`name`	string
`plan`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`default_currency`	string
`reporting_timezone`	string
`caps_timezone`	string
`locale`	string
`data_region`	string
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`branding`	object (free-form)
`portal_domains`	object (free-form)
`terms_and_conditions`	string
`signup_questions_partner`	array of object (free-form)
`signup_questions_advertiser`	array of object (free-form)
`partner_signup_mode`	string
`partner_visibility_defaults`	object (free-form)
`feature_flags`	object (free-form)
`retention_days_raw`	integer
`retention_days_aggregates`	integer
`api_rate_limits`	object (free-form)
`settings`	object (free-form)

TenantUpdate

Field	Type	Flags	Description
`slug`	string
`name`	string
`plan`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`default_currency`	string
`reporting_timezone`	string
`caps_timezone`	string
`locale`	string
`data_region`	string
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`branding`	object (free-form)
`portal_domains`	object (free-form)
`terms_and_conditions`	string
`signup_questions_partner`	array of object (free-form)
`signup_questions_advertiser`	array of object (free-form)
`partner_signup_mode`	string
`partner_visibility_defaults`	object (free-form)
`feature_flags`	object (free-form)
`retention_days_raw`	integer
`retention_days_aggregates`	integer
`api_rate_limits`	object (free-form)
`settings`	object (free-form)

TermsVersion

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`portal`	enum: `partner`, `advertiser`
`number`	integer	read-only
`title`	string
`body`	string
`status`	string	read-only
`requires_reacceptance`	boolean
`published_at`	string (date-time)	read-only

TermsVersionCreate

Field	Type	Flags
`portal`	enum: `partner`, `advertiser`
`title`	string	required
`body`	string
`requires_reacceptance`	boolean

TermsVersionList

Field	Type	Flags	Description
`data`	array of TermsVersion	required
`page`	Page	required

TermsVersionUpdate

Field	Type	Flags	Description
`portal`	enum: `partner`, `advertiser`
`title`	string
`body`	string
`requires_reacceptance`	boolean

ToolResult

Type: object (free-form)

TopupList

rows[] of top-ups, has_more

Type: object (free-form)

TrackingDomain

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`host`	string
`protocol`	string
`type`	enum: `click`, `impression`, `conversion_pixel`, `landing`, `partner_portal`, `advertiser_portal`, `admin_portal`, `unilink`
`visibility`	string
`partner_ids`	array of string
`is_default`	boolean
`status`	enum: `pending_dns`, `verifying`, `active`, `ssl_pending`, `error`, `disabled`	read-only
`ssl_mode`	enum: `auto_acme`, `cloudflare_saas`, `custom_cert`
`cname_target`	string	read-only
`verified_at`	string (date-time)	read-only
`is_ssl_forced`	boolean
`legacy_style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`legacy_id_map`	object (free-form)		old id -> new id
`health`	object (free-form)
`region`	string
`verification_token`	string	read-only
`ssl_status`	enum: `none`, `pending`, `issued`, `error`	read-only
`ssl_expires_at`	string (date-time)	read-only
`status_reason`	string	read-only
`last_checked_at`	string (date-time)	read-only
`verification`	object (free-form)		verify result: status, reason, cname_ok, txt_ok (verify only)
`dns_records`	array of object (free-form)

TrackingDomainCreate

Field	Type	Flags	Description
`host`	string	required
`protocol`	string
`type`	enum: `click`, `impression`, `conversion_pixel`, `landing`, `partner_portal`, `advertiser_portal`, `admin_portal`, `unilink`
`visibility`	string
`partner_ids`	array of string
`is_default`	boolean
`ssl_mode`	enum: `auto_acme`, `cloudflare_saas`, `custom_cert`
`is_ssl_forced`	boolean
`legacy_style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`legacy_id_map`	object (free-form)		old id -> new id
`health`	object (free-form)
`region`	string
`verification`	object (free-form)		verify result: status, reason, cname_ok, txt_ok (verify only)
`dns_records`	array of object (free-form)

TrackingDomainList

Field	Type	Flags	Description
`data`	array of TrackingDomain	required
`page`	Page	required

TrackingDomainUpdate

Field	Type	Description
`host`	string
`protocol`	string
`type`	enum: `click`, `impression`, `conversion_pixel`, `landing`, `partner_portal`, `advertiser_portal`, `admin_portal`, `unilink`
`visibility`	string
`partner_ids`	array of string
`is_default`	boolean
`ssl_mode`	enum: `auto_acme`, `cloudflare_saas`, `custom_cert`
`is_ssl_forced`	boolean
`legacy_style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`legacy_id_map`	object (free-form)	old id -> new id
`health`	object (free-form)
`region`	string
`verification`	object (free-form)	verify result: status, reason, cname_ok, txt_ok (verify only)
`dns_records`	array of object (free-form)

TrackingLinkRequest

Field	Type	Flags	Description
`partner_id`	string	required
`tracking_domain_id`	string
`landing_page_id`	string
`creative_id`	string
`style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`params`	object (free-form)		sub1.. source etc.
`deep_link`	string
`encode_deep_link`	boolean
`with_qr`	boolean
`with_pixels`	boolean
`google_ads_format`	boolean
`force_transparent`	boolean

TrackingLinkResult

Field	Type	Description
`url`	string
`impression_url`	string
`click_pixel_html`	string
`impression_pixel_html`	string
`qr_png_base64`	string
`qr_data_url`	string
`legacy_urls`	object (free-form)	style -> url

TrafficSource

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`type`	string
`cost_model`	string
`postback_template`	string
`cost_tokens`	object (free-form)
`parameters`	array of object (free-form)
`is_visible_to_partners`	boolean
`status`	string

TrafficSourceCreate

Field	Type	Flags
`name`	string	required
`type`	string
`cost_model`	string
`postback_template`	string
`cost_tokens`	object (free-form)
`parameters`	array of object (free-form)
`is_visible_to_partners`	boolean
`status`	string

TrafficSourceList

Field	Type	Flags	Description
`data`	array of TrafficSource	required
`page`	Page	required

TrafficSourceUpdate

Field	Type	Flags	Description
`name`	string
`type`	string
`cost_model`	string
`postback_template`	string
`cost_tokens`	object (free-form)
`parameters`	array of object (free-form)
`is_visible_to_partners`	boolean
`status`	string

Unilink

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`template_id`	string
`code`	string		generated when omitted; short link https://{domain}/u/{code}
`name`	string
`status`	enum: `active`, `paused`, `archived`
`offer_id`	string
`partner_id`	string
`params`	object (free-form)		sub1..sub5, source, campaign (strings)
`deep_link_value`	string
`payload`	object (free-form)
`web_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string

UnilinkCreate

Field	Type	Flags	Description
`template_id`	string	required
`code`	string		generated when omitted; short link https://{domain}/u/{code}
`name`	string
`status`	enum: `active`, `paused`, `archived`
`offer_id`	string
`partner_id`	string
`params`	object (free-form)		sub1..sub5, source, campaign (strings)
`deep_link_value`	string
`payload`	object (free-form)
`web_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string

UnilinkList

Field	Type	Flags	Description
`data`	array of Unilink	required
`page`	Page	required

UnilinkTemplate

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`status`	enum: `active`, `paused`, `archived`
`tracking_domain_id`	string		empty = every tracking domain
`ios_app_id`	string
`android_app_id`	string
`ios_team_id`	string		Apple Team ID (AASA appID prefix)
`ios_scheme`	string
`ios_universal_links`	boolean
`ios_store_url`	string
`ios_fallback`	enum: `store`, `web`
`android_scheme`	string
`android_app_links`	boolean
`android_store_url`	string
`android_sha256_fingerprints`	array of string
`android_fallback`	enum: `store`, `web`
`android_intent`	boolean
`web_url`	string
`desktop_behavior`	enum: `web`, `qr_page`, `custom`
`desktop_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string
`deferred_enabled`	boolean
`deferred_ttl_hours`	integer
`fingerprint_ttl_minutes`	integer
`default_payload`	object (free-form)

UnilinkTemplateCreate

Field	Type	Flags	Description
`name`	string	required
`status`	enum: `active`, `paused`, `archived`
`tracking_domain_id`	string		empty = every tracking domain
`ios_app_id`	string
`android_app_id`	string
`ios_team_id`	string		Apple Team ID (AASA appID prefix)
`ios_scheme`	string
`ios_universal_links`	boolean
`ios_store_url`	string
`ios_fallback`	enum: `store`, `web`
`android_scheme`	string
`android_app_links`	boolean
`android_store_url`	string
`android_sha256_fingerprints`	array of string
`android_fallback`	enum: `store`, `web`
`android_intent`	boolean
`web_url`	string
`desktop_behavior`	enum: `web`, `qr_page`, `custom`
`desktop_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string
`deferred_enabled`	boolean
`deferred_ttl_hours`	integer
`fingerprint_ttl_minutes`	integer
`default_payload`	object (free-form)

UnilinkTemplateList

Field	Type	Flags	Description
`data`	array of UnilinkTemplate	required
`page`	Page	required

UnilinkTemplateUpdate

Field	Type	Description
`name`	string
`status`	enum: `active`, `paused`, `archived`
`tracking_domain_id`	string	empty = every tracking domain
`ios_app_id`	string
`android_app_id`	string
`ios_team_id`	string	Apple Team ID (AASA appID prefix)
`ios_scheme`	string
`ios_universal_links`	boolean
`ios_store_url`	string
`ios_fallback`	enum: `store`, `web`
`android_scheme`	string
`android_app_links`	boolean
`android_store_url`	string
`android_sha256_fingerprints`	array of string
`android_fallback`	enum: `store`, `web`
`android_intent`	boolean
`web_url`	string
`desktop_behavior`	enum: `web`, `qr_page`, `custom`
`desktop_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string
`deferred_enabled`	boolean
`deferred_ttl_hours`	integer
`fingerprint_ttl_minutes`	integer
`default_payload`	object (free-form)

UnilinkUpdate

Field	Type	Description
`template_id`	string
`code`	string	generated when omitted; short link https://{domain}/u/{code}
`name`	string
`status`	enum: `active`, `paused`, `archived`
`offer_id`	string
`partner_id`	string
`params`	object (free-form)	sub1..sub5, source, campaign (strings)
`deep_link_value`	string
`payload`	object (free-form)
`web_url`	string
`og_title`	string
`og_description`	string
`og_image_url`	string

Usage

Field	Type	Flags	Description
`period`	string
`meters`	array of object (free-form)
`limits`	object (free-form)

User

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`email`	string (email)
`name`	string
`status`	string
`mfa_enabled`	boolean	read-only
`last_login_at`	string (date-time)	read-only
`locale`	string
`timezone`	string
`avatar_url`	string

UserCreate

Field	Type	Flags
`email`	string (email)	required
`name`	string	required
`status`	string
`locale`	string
`timezone`	string
`avatar_url`	string

UserList

Field	Type	Flags	Description
`data`	array of User	required
`page`	Page	required

UserUpdate

Field	Type	Flags	Description
`email`	string (email)
`name`	string
`status`	string
`locale`	string
`timezone`	string
`avatar_url`	string

WP80Report

Field	Type	Description
`columns`	array of string
`rows`	array of object (free-form)
`totals_by_currency`	object (free-form)	SKU report: lines, quantity and money totals per currency
`totals`	object (free-form)	fail-traffic report: clicks, unique_clicks, conversions, approved_conversions, rejected_conversions
`capped`	boolean
`from`	string
`to`	string

WP80ReportQuery

WP-80 report body: from / to (YYYY-MM-DD, inclusive, or RFC 3339), timezone, group_by (SKU report: offer | partner | day besides sku), filters, include_test, limit (default 1000, max 5000)

Field	Type	Flags
`from`	string	required
`to`	string	required
`timezone`	string
`group_by`	array of string
`offer_ids`	array of string
`partner_ids`	array of string
`sku`	string
`include_test`	boolean
`limit`	integer

WalletLedger

Field	Type	Flags	Description
`data`	array of object (free-form)
`has_more`	boolean

WalletTopupCreated

Field	Type	Description
`topup_id`	string
`reference`	string
`invoice_number`	string
`wallet`	AdvertiserWallet	Prepaid wallet: the ledger account advertiser_prepaid:{advertiser}:{ccy} with its settings and state

WalletTopupRequest

Field	Type	Flags	Description
`amount`	string	required	decimal string
`currency`	string
`method`	enum: `manual`, `invoice`
`reference`	string
`rail`	string
`note`	string
`due_days`	integer

Webhook

Field	Type	Flags	Description
`id`	string	read-only
`display_id`	integer	read-only
`hash_id`	string	read-only
`external_ref`	string
`custom_fields`	object (free-form)		tenant-defined fields
`version`	integer	read-only
`created_at`	string (date-time)	read-only
`updated_at`	string (date-time)	read-only
`deleted_at`	string (date-time)	read-only
`name`	string
`url`	string
`method`	enum: `POST`, `GET`
`secret`	string
`events`	array of string
`headers`	object (free-form)
`status`	string
`consecutive_failures`	integer	read-only

WebhookCreate

Field	Type	Flags
`name`	string	required
`url`	string	required
`method`	enum: `POST`, `GET`
`secret`	string
`events`	array of string	required
`headers`	object (free-form)
`status`	string

WebhookEvent

Field	Type	Flags	Description
`name`	string
`description`	string
`webhook`	boolean
`firehose`	boolean
`sample`	object (free-form)

WebhookEventList

Field	Type	Flags	Description
`data`	array of WebhookEvent

WebhookList

Field	Type	Flags	Description
`data`	array of Webhook	required
`page`	Page	required

WebhookSecret

id, secret (shown once)

Type: object (free-form)

WebhookStats

days, daily[] {day, success, failed, retrying, p95_ms}, webhooks[] {webhook_id, total, success, last_delivery_at, p95_ms}

Type: object (free-form)

WebhookTestRequest

event: webhook catalogue name (default conversion.created)

Type: object (free-form)

WebhookTestResult

ok, response_code, response_body, latency_ms, request_body, error, explanation

Type: object (free-form)

WebhookUpdate

Field	Type	Flags	Description
`name`	string
`url`	string
`method`	enum: `POST`, `GET`
`secret`	string
`events`	array of string
`headers`	object (free-form)
`status`	string

WorkspacePlan

Field	Type	Description
`plan`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`billing_provider`	string
`limits`	object (free-form)
`click_overage`	enum: `allow`, `block`
`trial_ends_at`	string (date-time)
`managed`	boolean
`usage`	object (free-form)	seats, pending_invites, domains, clicks_month

WorkspaceSignup

Self-service workspace signup

Field	Type	Flags	Description
`company`	string	required
`name`	string	required	owner name
`email`	string (email)	required
`password`	string	required	12+ characters
`slug`	string	required	workspace address: 3-40 of a-z 0-9 -
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`data_region`	enum: `us`, `eu`, `in`, `ap`
`sample_data`	boolean
`locale`	string
`website`	string		honeypot: leave empty
`started_at`	integer		ms epoch when the form rendered (browser signups)

WorkspaceSignupAccepted

Field	Type	Flags	Description
`ok`	boolean
`email`	string
`expires_in_hours`	integer

WorkspaceSlugCheck

Field	Type	Flags	Description
`slug`	string
`available`	boolean
`reason`	string

WorkspaceVerified

Field	Type	Flags	Description
`tenant_id`	string
`tenant_slug`	string
`principal_type`	string
`redirect`	string
`sample_data`	boolean

WorkspaceVerify

Field	Type	Flags	Description
`token`	string	required