Skip to main content
The GET /v1/reports/outclick endpoint returns the outclick events recorded for your account — product clicks by default, or merchant clicks with offer_type=merchant. A product event includes the click metadata, the price and provider data captured at click time, the product name and direct URL from the stored offer snapshot, and the client details; a merchant event carries the merchant/network identity but no product snapshot (see Merchant outclicks). Requires a token with API product access.

Endpoint

Key behavior

  • Each query is limited to a 24-hour window and excludes the most recent 5 minutes.
  • Returns product and merchant outclicks — pick with offer_type (defaults to product). Promotion outclicks are intentionally excluded.
  • All filters are exact matches.
  • Robot clicks are excluded unless include_robots=true.
  • Results are ordered newest first (created_at descending).
  • Prices are returned as floats (e.g. 131.25).
  • Each request bills one API unit, regardless of how many rows are returned.

Merchant outclicks

Pass offer_type=merchant to return clicks on merchant outclick links — the outclick field of a providers[] entry (e.g. a homepage link to a service merchant such as HelloFresh or Avis), including AdMedia merchant links. A merchant click carries the merchant identity but no product snapshot:
  • offer_type is merchant, and the top-level merchant (id, object_id, name) and network (id, object_id, name) objects are populated.
  • product is null — a merchant has no offer/feed row, so there is nothing to snapshot.
  • sub_id, client.*, country, and origin_query_parameters are populated as usual.
Narrow merchant clicks with merchant_object_id (nmer_…), network_object_id (rnet_…), or sub_id.

Troubleshooting — a click isn’t showing

The most common cause of an empty result right after a test click is the 5-minute window, not missing data.
  • Wait 5 minutes. end_at must be at least 5 minutes in the past, so a click isn’t queryable until ~5 minutes after it happens. A window whose end_at is older than the click returns nothing.
  • Match the account. A click is owned by the account whose API key minted the outclick (baked in at link-build time), not the one that clicks it. Query with that same key — a different account won’t see it.
  • sub_id is exact, and stored verbatim. If you leave the {AFF_ID}/{SUB_ID} (or @@@/###) placeholders in the link unreplaced, they’re recorded literally (e.g. sub_id becomes {SUB_ID}), so a tag filter won’t match. Replace the slots with real values before clicking.
  • Robots are excluded by default. Add include_robots=true if you’re testing with a tool or headless browser.
  • Product-snapshot timing. The click row is written synchronously, but the product snapshot is enriched by a background job — so on a product click the row can appear a moment before its product block is fully populated under load. Merchant clicks have no snapshot, so nothing lags.

Headers

string
required
Bearer token for authentication. Format: Bearer {your_api_key}.

Query parameters

string
required
Inclusive start of the window. Accepts an RFC 3339 timestamp (e.g. 2026-07-23T00:00:00Z) or a UTC date (2026-07-23). A bare date resolves to midnight UTC. Maximum 64 characters.
string
required
Exclusive end of the window. Accepts an RFC 3339 timestamp or a UTC date. A bare date resolves to midnight UTC of the next day, so passing the same bare date as start_at requests the full UTC day. Must be after start_at, no more than 24 hours after start_at, and at least 5 minutes in the past. Maximum 64 characters.
integer
default:"1"
The page number to return. Integer, at least 1.
integer
default:"100"
The number of events to return per page. Integer from 1 through 1000.
string
default:"product"
product or merchant. Selects which kind of outclick to return. See Merchant outclicks.
string
Exact sub ID match. Maximum 1,024 characters.
string
Exact product ID match. Maximum 1,024 characters.
string
Exact provider (network merchant) ID match. Maximum 255 characters.
string
Exact Affiliate.com merchant object ID. Requires the nmer_ prefix (e.g. nmer_01khfmtj1vpvy6345xfhwepz9t).
string
Exact provider (network) ID match. Maximum 255 characters.
string
Exact Affiliate.com network object ID. Requires the rnet_ prefix (e.g. rnet_01kkgbyq466tn06cgev3b1dnaa).
string
Two-letter client country code. Normalized to uppercase.
boolean
default:"false"
When true, includes both robot and non-robot clicks. Defaults to false (non-robot clicks only).
string
Comma-separated string or fields[] array selecting which fields to return. Between 1 and 50 fields. Omitting it returns all fields. Accepts any leaf field path listed under Response fields, plus the parent paths product, product.urls, product.merchant, product.network, and client (which select the whole sub-object).

Example requests

Retrieve one day of outclicks:
Select a subset of fields for the full UTC day:

Response

Response fields

meta object

integer
Total number of events matching the query.
integer
Index of the first event on the current page. null when there are no results.
integer
Index of the last event on the current page. null when there are no results.
integer
The current page number.
integer
The total number of pages.
integer
The number of records per page.
string[]
The field paths included in each event.
string
Unique identifier for this request. Include this value when contacting support.

Event object (data[])

string
Unique identifier for the click event.
string
Click timestamp, ISO 8601 (UTC).
string
The event type (e.g. click).
string
The offer type: product or merchant (matches the offer_type filter).
string
The account that owns the click.
integer
The team that owns the click.
string
The provider tracking URL the click was sent to.
string
The Affiliate.com outclick URL that initiated the redirect.
object
Query parameters captured from the origin URL (e.g. affiliate_id, sub_id).
string
The sub ID recorded on the click.
string
Trace identifier for the click.
boolean
Whether click tracking was enabled for this outclick.
object
Merchant identity (id, object_id, name). Populated for merchant outclicks; on product clicks the merchant is under product.merchant.
object
Network identity (id, object_id, name). Populated for merchant outclicks; on product clicks the network is under product.network.
object
The offer snapshot for product outclicks. null on merchant outclicks.
object
The client (visitor) data captured at click time.