Reporting - Everflow API

Which reporting tool should I use?

Aggregated stats (totals, trends, breakdowns) → run_performance_report or run_network_summary
Raw event records (individual clicks or conversions over a window) → search_clicks or search_conversions
Single event by ID (attribution troubleshooting, dispute resolution) → get_click or get_conversion

get_report_schema

Returns the complete list of valid dimension keys, filter keys, and metric names for run_performance_report. Call this first if you’re unsure which keys to use — the exact strings returned here are the accepted values for dimensions, filters, and sort_by. Parameters: None. Response fields:

Field	Type	Description
`columns`	array	Valid dimension keys for the `dimensions` parameter
`filters`	array	Valid filter keys for the `filters` parameter
`metrics`	array	Valid metric names for `sort_by` — also returned in every report row

run_performance_report

Queries aggregated performance data grouped by one or more dimensions. The primary tool for campaign analysis, partner comparison, and revenue reporting. Parameters:

Parameter	Type	Required	Description
`from`	string	Yes	Start date (`YYYY-MM-DD`)
`to`	string	Yes	End date (`YYYY-MM-DD`)
`dimensions`	string	Yes	Comma-separated dimensions (see below) — max 256 chars
`filters`	string	No	Comma-separated inclusive `type:value` pairs — e.g. `offer:123,affiliate:456` — max 4,096 chars total; sub-param values (`sub1`–`sub5`, `adv1`–`adv5`, `source_id`) max 600 chars each. Only inclusive filters are supported — there is no exclusion syntax.
`sort_by`	string	No	Metric name to sort by (see metrics accordion below) — max 128 chars
`sort_direction`	string	No	`asc` or `desc` (default: `desc`) — max 8 chars
`timezone`	string	No	IANA timezone name — max 64 chars
`currency`	string	No	Currency code (default: `USD`) — max 8 chars
`page_size`	number	No	Rows per page (1–100, default 50)
`cursor`	string	No	Pagination cursor from a prior response — max 1,024 chars

Response envelope:

run_performance_report uses total_rows (not total_matching) in its pagination envelope, which differs from list tools like list_offers and list_affiliates.

Field	Type	Description
`next_cursor`	string	Pass as `cursor` to retrieve the next page. Absent when there are no further pages.
`rows_returned`	number	Number of rows in this page
`total_rows`	number	Total rows matching the query across all pages
`truncated`	boolean	`true` when the query matched more than 500 total rows — the result set is capped at 500 rows across all pages. Narrow your date range, add filters, or reduce the number of dimensions to get under the limit.
`warning`	string	Present when `truncated` is `true` — human-readable message describing the truncation.

Available dimensions (81 total)

Pass one or more of these keys as a comma-separated dimensions string.Time

Dimension	Description
`date`	Day (YYYY-MM-DD)
`hour`	Hour of day (0–23)
`hourly`	Full datetime rounded to the hour
`week`	ISO week
`month`	Month (YYYY-MM)
`year`	Year
`day_of_week`	Day of week (0 = Sunday … 6 = Saturday)

Entities

Dimension	Description
`offer`	Offer name
`offer_id`	Offer ID
`affiliate`	Affiliate name
`affiliate_id`	Affiliate ID
`advertiser`	Advertiser name
`advertiser_id`	Advertiser ID
`campaign`	Smart link / campaign name
`campaign_id`	Campaign ID
`creative`	Creative name
`creative_id`	Creative ID
`offer_group`	Offer group name
`offer_group_id`	Offer group ID
`offer_url`	Offer URL
`offer_status`	Offer status
`affiliate_status`	Affiliate status
`originating_offer`	Originating offer in a redirect chain
`category`	Offer category
`network`	Network identifier
`source_id`	Traffic source ID
`event_name`	Conversion event name
`advertiser_event_name`	Advertiser-side event name
`advertiser_campaign_name`	Advertiser campaign name

Geo

Dimension	Description
`country`	Country name
`country_code`	ISO 2-letter country code
`region`	Region / state
`city`	City
`dma`	Designated market area (US only)
`postal_code`	Postal code

Device & Technology

Dimension	Description
`browser`	Browser name
`platform`	OS platform
`device_type`	Device type (desktop, mobile, tablet)
`device_make`	Device manufacturer
`device_model`	Device model
`os_version`	OS version string
`language`	Browser language
`connection_type`	Connection type (wifi, cellular, etc.)
`carrier`	Mobile carrier
`isp`	Internet service provider
`is_proxy`	Whether traffic came through a proxy
`meta_platform`	Meta / Facebook platform

Tracking & Attribution

Dimension	Description
`tracking_domain`	Custom tracking domain
`transaction_id`	Raw transaction ID
`attribution_method`	Attribution method
`order_id`	Order ID passed on conversion
`coupon_code`	Coupon code
`referer`	Referring URL
`click_error_code`	Click error code
`conversion_error_code`	Conversion error code

People & Managers

Dimension	Description
`affiliate_manager`	Affiliate manager name
`account_manager`	Account manager name
`sales_manager`	Sales manager name
`account_executive`	Account executive name
`customer_support_manager`	Customer support manager name
`admin_account_manager`	Admin account manager name

Payout & Revenue

Dimension	Description
`payout_type`	Payout model (CPA, CPC, etc.)
`payout_amount`	Payout amount
`revenue_type`	Revenue model
`revenue_amount`	Revenue amount
`currency`	Currency code
`custom_payout_revenue`	Custom payout/revenue rule name
`custom_payout_revenue_id`	Custom payout/revenue rule ID

Sub-Parameters

Dimension	Description
`sub1`–`sub5`	Affiliate sub parameters (pass separately: `sub1`, `sub2`, …)
`adv1`–`adv5`	Advertiser sub parameters (pass separately: `adv1`, `adv2`, …)

App

Dimension	Description
`project_id`	App project ID
`app_identifier`	App identifier
`bundle_id`	App bundle ID

Available filters (66 total)

Pass filters as comma-separated inclusive type:value pairs — e.g. offer:123,affiliate:456,country_code:US. Only inclusive filters are supported — there is no exclusion syntax. status is not a supported filter or dimension on this tool; to filter conversions by status, use search_conversions instead.Entities

Filter	Value format	Example
`offer`	Numeric offer ID	`offer:123`
`offer_group`	Numeric offer group ID	`offer_group:45`
`affiliate`	Numeric affiliate ID	`affiliate:678`
`advertiser`	Numeric advertiser ID	`advertiser:99`
`creative`	Numeric creative ID	`creative:12`
`campaign`	Numeric campaign ID	`campaign:7`
`category`	Numeric category ID	`category:3`
`network`	Numeric network ID	`network:1`
`source_id`	String	`source_id:google`
`event_name`	String	`event_name:purchase`
`offer_url`	Numeric URL ID	`offer_url:8`
`offer_status`	`active`, `paused`, `pending`, `deleted`	`offer_status:active`
`originating_offer`	Numeric offer ID	`originating_offer:123`
`transaction_id`	32-char hex string	`transaction_id:abc123...`
`error_code`	Numeric error code	`error_code:0`
`coupon_code`	String	`coupon_code:SUMMER20`
`tracking_domain`	Numeric domain ID	`tracking_domain:5`
`channel`	Numeric channel ID	`channel:2`

Geo

Filter	Value format	Example
`country`	Country name	`country:United States`
`country_code`	ISO 2-letter code	`country_code:US`
`region`	Region / state name	`region:California`
`city`	City name	`city:New York`
`dma`	DMA name	`dma:New York`

Device & Technology

Filter	Value format	Example
`browser`	Browser name	`browser:Chrome`
`device_type`	`desktop`, `mobile`, `tablet`	`device_type:mobile`
`device_platform`	Platform string	`device_platform:iOS`
`device_make`	Manufacturer name	`device_make:Apple`
`device_model`	Model name	`device_model:iPhone 15`
`os_version`	OS version string	`os_version:iOS 17`
`carrier`	Carrier name	`carrier:Verizon`
`language`	Browser language code	`language:en-US`
`connection_type`	Connection type string	`connection_type:wifi`
`isp`	ISP name	`isp:Comcast`

People & Managers

Filter	Value format	Example
`account_manager`	Numeric employee ID	`account_manager:55`
`affiliate_manager`	Numeric employee ID	`affiliate_manager:12`
`sales_manager`	Numeric employee ID	`sales_manager:8`
`account_executive`	Numeric employee ID	`account_executive:3`
`customer_support_manager`	Numeric employee ID	`customer_support_manager:9`

Payout & Revenue

Filter	Value format	Example
`currency`	ISO currency code	`currency:USD`
`revenue_type`	Revenue type string	`revenue_type:cpa`
`revenue_amount`	Numeric amount	`revenue_amount:10`
`payout_type`	Payout type string	`payout_type:cpa`
`payout_amount`	Numeric amount	`payout_amount:5`
`billing_frequency`	Frequency string	`billing_frequency:monthly`

Sub-Parameters

Filter	Value format	Example
`sub1`–`sub5`	String	`sub1:source_a`
`adv1`–`adv5`	String	`adv1:campaign_x`

Business & Labels

Filter	Value format	Example
`label`	Label name	`label:top_affiliate`
`business_unit`	Business unit name	`business_unit:retail`
`project_id`	Numeric project ID	`project_id:101`
`affiliate_tier`	Tier name	`affiliate_tier:gold`
`network_status`	Status string	`network_status:active`
`partner_type`	Partner type string	`partner_type:influencer`
`partner`	Partner name or ID	`partner:42`
`vertical`	Vertical name	`vertical:ecommerce`
`client_type`	Client type string	`client_type:managed`
`offer_type`	Offer type string	`offer_type:cost_per_action`
`advertiser_billing_frequency`	Billing frequency	`advertiser_billing_frequency:weekly`
`customer_billing_item_type`	Billing item type	`customer_billing_item_type:invoice`

Available metrics (22 total)

These are also the valid values for the sort_by parameter.Volume

Metric	Description
`impressions`	Total impression count
`gross_clicks`	All clicks including duplicates
`clicks`	Valid clicks
`unique_clicks`	Deduplicated clicks
`duplicate_clicks`	Duplicate clicks within dedup window
`invalid_clicks`	Clicks flagged as invalid
`conversions`	Approved conversions
`total_conversions`	All conversions regardless of status
`events`	Post-conversion events

Revenue & Cost

Metric	Description
`payout`	Total affiliate payout
`revenue`	Total advertiser revenue
`profit`	Revenue minus payout
`gross_sales`	Gross sale amount
`media_buying_cost`	Media buying cost

Rates & Efficiency

Metric	Description
`ctr`	Click-through rate
`cvr`	Conversion rate
`epc`	Earnings per click
`rpc`	Revenue per click
`cpa`	Cost per action
`cpc`	Cost per click
`cpm`	Cost per thousand impressions
`roas`	Return on ad spend
`margin`	Profit margin percentage

run_network_summary

Returns headline performance totals for a date range — no grouping, just aggregate numbers. Optionally includes a comparison against the prior equivalent period. Parameters:

Parameter	Type	Required	Description
`from`	string	Yes	Start date (`YYYY-MM-DD`)
`to`	string	Yes	End date (`YYYY-MM-DD`)
`timezone`	string	No	IANA timezone name — max 64 chars
`currency`	string	No	Currency code (default: `USD`) — max 8 chars
`include`	string	No	`comparison` — adds prior-period metrics for delta analysis — max 256 chars

search_clicks

Searches raw click events within a date-time window.

This tool is not paginated. It returns a single capped result set — at most 1,000 records, sorted by most recent first. The response includes a capped_at field indicating the ceiling. If you need aggregated counts instead of raw records, use run_performance_report.

Results are automatically filtered by affiliate visibility. If your account has a limited affiliate scope, rows for affiliates outside that scope are silently excluded. This may cause result counts to be lower than expected when querying without an affiliate_id filter.

Parameters:

Parameter	Type	Required	Description
`from`	string	Yes	Start datetime (`YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`)
`to`	string	Yes	End datetime — maximum 14-day window from `from`
`offer_id`	string	No	Filter by offer ID — max 64 chars
`affiliate_id`	string	No	Filter by affiliate ID — max 64 chars
`advertiser_id`	string	No	Filter by advertiser ID — max 64 chars
`error_code`	string	No	Filter by error code — max 64 chars
`country`	string	No	Filter by 2-letter ISO country code — max 64 chars
`sub1`–`sub5`	string	No	Filter by sub parameter value — max 600 chars each
`source_id`	string	No	Filter by traffic source ID — max 600 chars

Response envelope:

Field	Type	Description
`clicks`	array	Array of click records (see fields below)
`total`	number	Number of records returned
`capped_at`	number	Hard ceiling applied — always `1000`

Per-record fields:

Field	Type	Description
`transaction_id`	string	Transaction ID
`timestamp`	string	Click datetime (UTC, `YYYY-MM-DD HH:MM:SS`)
`offer_id`	number	Offer ID
`affiliate_id`	number	Affiliate ID
`advertiser_id`	number	Advertiser ID
`error_code`	number	Error code (0 = no error)
`is_unique`	boolean	Whether this was a unique click
`payout`	number	Payout amount
`revenue`	number	Revenue amount
`currency`	string	Currency code
`country`	string	Country code (if present)
`sub1`–`sub5`	string	Sub parameters (omitted if empty)
`source_id`	string	Traffic source ID (omitted if empty)
`campaign_id`	number	Campaign ID (omitted if not set)

search_conversions

Searches conversion events within a date-time window.

This tool is not paginated. It returns a single capped result set — at most 500 records, sorted by most recent first. The response includes a capped_at field indicating the ceiling. For aggregated conversion counts, use run_performance_report.

Parameters:

Use full UTC day windows for reliable results — YYYY-MM-DD 00:00:00 to YYYY-MM-DD 23:59:59. Sub-hour windows may return an error.

Parameter	Type	Required	Description
`from`	string	Yes	Start datetime (`YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`). Use `00:00:00` for reliability.
`to`	string	Yes	End datetime (`YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`). Use `23:59:59` for reliability.
`offer_id`	string	No	Filter by offer ID — max 64 chars
`affiliate_id`	string	No	Filter by affiliate ID — max 64 chars
`advertiser_id`	string	No	Filter by advertiser ID — max 64 chars
`status`	string	No	`approved`, `pending`, `rejected`, `invalid` — max 64 chars
`sub1`–`sub5`	string	No	Filter by affiliate sub parameter value — max 600 chars each
`adv1`–`adv5`	string	No	Filter by advertiser sub parameter value — max 600 chars each
`source_id`	string	No	Filter by traffic source ID — max 600 chars
`country`	string	No	Filter by 2-letter ISO country code — max 64 chars

Response envelope:

Field	Type	Description
`conversions`	array	Array of conversion records (see fields below)
`total`	number	Number of records returned
`capped_at`	number	Hard ceiling applied — always `500`

Per-record fields:

Field	Type	Description
`conversion_id`	string	Conversion ID
`transaction_id`	string	Click transaction ID
`timestamp`	string	Conversion datetime (UTC, `YYYY-MM-DD HH:MM:SS`)
`status`	string	Conversion status
`offer_id`	number	Offer ID
`offer_name`	string	Offer name
`affiliate_id`	number	Affiliate ID
`affiliate_name`	string	Affiliate name
`payout`	number	Payout amount
`revenue`	number	Revenue amount
`country`	string	Country code (if present)
`sub1`–`sub5`	string	Sub parameters (omitted if empty)
`order_id`	string	Order ID (omitted if empty)
`coupon_code`	string	Coupon code (omitted if empty)
`is_scrub`	boolean	Present and `true` if conversion was scrubbed

get_click

Looks up a single click event by transaction ID. Use this as the first step when a partner reports a missing click, tracking failure, or attribution dispute. Parameters:

Parameter	Type	Required	Description
`transaction_id`	string	Yes	The 32-character transaction ID

Response fields:

Field	Description
`transaction_id`	Transaction ID
`timestamp`	Click datetime (UTC)
`offer_id`, `offer_name`	Offer
`affiliate_id`, `affiliate_name`	Affiliate
`advertiser_id`, `advertiser_name`	Advertiser
`campaign_id`	Campaign ID (if set)
`error_code`, `error_message`	Error details (0 = no error)
`is_unique`, `is_view_through`, `is_test_mode`	Click flags
`payout`, `revenue`, `currency`	Financial
`country`, `region`, `city`	Geo
`browser`, `platform`, `device_type`, `os_version`	Device
`user_ip`	Client IP
`sub1`–`sub5`	Sub parameters
`source_id`, `referer`, `coupon_code`	Source data
`has_conversion`	Whether this click converted
`previous_transaction_id`	Prior click in redirect chain

get_conversion

Looks up a single conversion event by conversion ID. Parameters:

Parameter	Type	Required	Description
`conversion_id`	string	Yes	The unique conversion ID

Response fields:

Field	Description
`conversion_id`, `transaction_id`	Identifiers
`timestamp`, `click_timestamp`	Event datetimes (UTC)
`status`, `error_code`, `error_message`	Status and error
`offer_id`, `offer_name`	Offer
`affiliate_id`, `affiliate_name`	Affiliate
`advertiser_id`, `advertiser_name`	Advertiser
`campaign_id`	Campaign ID (if set)
`payout`, `revenue`, `sale_amount`	Financial
`payout_type`, `revenue_type`, `currency`	Payout structure
`event_id`, `event_name`	Conversion event
`order_id`, `coupon_code`	Order data
`is_scrub`, `is_view_through`	Flags
`country`, `region`, `city`	Geo
`platform`, `device_type`, `browser`, `os_version`	Device
`sub1`–`sub5`	Sub parameters
`adv1`–`adv5`	Advertiser sub parameters
`source_id`, `referer`	Source data

MCP Server

​get_report_schema

​run_performance_report

​run_network_summary

​search_clicks

​search_conversions

​get_click

​get_conversion

get_report_schema

run_performance_report

run_network_summary

search_clicks

search_conversions

get_click

get_conversion