Order statistics
get_order_statsRetrieves statistics for a buy or sell order grouped by dimension, with optional sub-breakdown. Use to analyze campaign or placement performance.
Instructions
Statistics of one buy or sell order grouped by a dimension. Buy rows: hits, unique, desktop, mobile, spent, cpm, conversions, cost_per_conversion, conversion_rate, conversion_revenue, winrate, profit. Sell rows: total, unique, sold, sent_back, earned, cpm. group_by=sub_id is sell-only; group_by=domain is not available for sticker sell orders. subdimension adds a nested sub breakdown to every row (must differ from group_by). from/size/order_field/order_direction paginate sell orders only; buy orders return up to 1000 rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Order ID (hex `id` or numeric `id_numeric`) | |
| isp | No | ISP names | |
| from | No | Sell only: row offset | |
| side | Yes | buy = advertiser campaigns (you pay for traffic); sell = publisher placements (you earn) | |
| size | No | Sell only: rows per page (default 50) | |
| format | Yes | Ad format | |
| date_end | No | Range end. RFC3339 (`2026-01-15T00:00:00Z`) or `2026-01-15`, UTC. Defaults to today. Max range 60 days, max lookback 90 days. | |
| group_by | Yes | ||
| platform | No | ||
| sub_size | No | Sub-rows per row (default 20, max 100) | |
| countries | No | ISO country codes, e.g. ["US", "DE"] | |
| mobile_os | No | Mobile OS names | |
| categories | No | Traffic categories | |
| date_start | No | Range start. RFC3339 (`2026-01-15T00:00:00Z`) or `2026-01-15`, UTC. Defaults to today. Max range 60 days, max lookback 90 days. | |
| desktop_os | No | Desktop OS names | |
| order_field | No | Sell only: earned, sold, hits, cpm or _key | |
| subdimension | No | Second-level breakdown; sub_id is sell-only | |
| source_domains | No | Source (referrer) domains | |
| mobile_browsers | No | Mobile browser names | |
| order_direction | No | Sell only | |
| desktop_browsers | No | Desktop browser names |