search_activity (type="click"), window | 14 days at most |
search_activity (type="click"), reachable clicks | The newest 1,000 clicks of the window. truncated is true when the scan reaches 1,000 clicks (which includes a window with exactly 1,000), so narrow the window or add filters when completeness matters |
search_activity (type="conversion"), window | Within the last 365 days and at most 367 days long. A window reaching further back is clamped to the last 365 days, and one entirely older is refused |
search_activity (type="conversion"), explicit times | A window with explicit HH:MM:SS times on both ends must be at least 23 hours, so use whole YYYY-MM-DD days. Click search accepts shorter timed windows |
search_activity, rows per page | 1 to 100 (default 50) |
run_performance_report, window | 367 days at most |
run_performance_report, rows | 500 across all pages. meta.result_capped is true (with meta.row_limit) when the cap drops rows, and the totals still cover every matched row |
run_performance_report, rows per page | 1 to 100 (default 50) |
run_performance_report, dimensions | 10 at most, and only one time dimension (hour, date, week or month) |
list_payments, window | An explicit from to to window is at most 366 days. Default: the last 90 days ending today. A request with an invoice_id and no dates covers all of that invoice’s payments |
list_payments, rows per page | 1 to 100 (default 25) |
list_offers, rows per page | 1 to 100 (default 25) |
list_offers, offer_ids | 25 ids at most |
list_offers, sort ceiling | A sort_by other than id works on at most 2,000 matching offers and is refused when more match, so narrow the filters first. A sort near the ceiling can take several seconds |
list_invoices, rows per page | 1 to 100 (default 25) |
list_invoices, sort ceiling | A sort_by other than invoice_id works on at most 500 matching invoices and is refused when more match, so narrow the filters first |
list_entities, rows per page | 1 to 100 (default 25) |
get_invoice, lines per page | 1 to 100 (default 100). A page of lines is also cut at about 12,000 characters |
get_invoice, payments | The first 50 recorded against the invoice. payments_total gives the full count, and list_payments with the same invoice_id lists every one |
get_offer, ids per batch | 25 via offer_ids, but 10 when include has payout, caps, targeting, description, tracking_url, urls, creatives or integrations. Exceeding it returns INVALID_ARGUMENT naming the cap |
| Page character budget | search_activity, list_invoices and list_payments cut a page to fit about 20,000 characters (the first row is always returned), so a page can hold fewer rows than page_size. A note says so. Keep paging while has_more is true |
| Long values in rows | Cut at 300 characters in raw activity rows and in invoice and payment notes |
| Rate limit | 10 requests per second per partner (a burst of up to 10, refilled at 10 tokens per second) |
| Reporting allowance | Reports on detail dimensions and click searches draw on an hourly allowance that is the same one the Affiliate API uses, shared by all the partners of your network, so another partner’s use can run it out for you too. When it is used up, the call returns RESOURCE_EXHAUSTED (see below) |
| Idle session | Cleaned up after 10 minutes. The client keeps working on the same session id |