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
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. Match several IDs for one ID filter by separating them with | — e.g. offer:1|2|5. 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
The filters parameter uses comma-separated type:value strings — for example offer:123,affiliate:456,country_code:US. To match multiple values for the same ID filter, separate them with a pipe — offer:1|2|5 returns all three offers in a single query instead of running a separate report per offer. This differs from list_entities, which accepts a JSON object. See the filters accordion below for all valid keys.
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.
When truncated is true, the agent is only seeing part of the data. To get complete results: narrow the date range, add more specific filters (e.g. a single affiliate or offer), or split the request into multiple smaller queries.
Available dimensions
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
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.Multiple values (OR): for any ID filter, separate IDs with a pipe to match any of them in one query — offer:1|2|5 returns offers 1, 2, and 5 together. Repeating a key (offer:1,offer:2) does the same. Supported on the ID filters: offer, offer_group, affiliate, advertiser, creative, campaign, category, network, tracking_domain, channel. Prefer one multi-value query over many single-ID queries.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 — region/city take internal numeric IDs; resolve a name to its ID with list_entities (type=region / type=city, and type=country for the country_id that scopes a region lookup).
Filter
Value format
Example
country
ISO 2-letter code (resolve names via list_entities type=country)
country:US
country_code
ISO 2-letter code
country_code:US
region
Numeric region ID (resolve via list_entities type=region)
region:1140
city
Numeric city ID (resolve via list_entities type=city, which requires region_id)
city:534
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
carrier
Carrier name
carrier:Verizon
language
Browser language code
language:en-US
connection_type
Connection type string
connection_type:wifi
People & Managers — numeric employee IDs; resolve a name with list_entities type=employee.
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
Sub-Parameters
Filter
Value format
Example
sub1–sub5
String
sub1:source_a
adv1–adv5
String
adv1:campaign_x
Billing & Labels
Filter
Value format
Example
label
Label name
label:top_affiliate
business_unit
Business unit name
business_unit:retail
affiliate_tier
Tier name
affiliate_tier:gold
billing_frequency
Frequency string
billing_frequency:monthly
advertiser_billing_frequency
Billing frequency
advertiser_billing_frequency:weekly
Available metrics
These are also the valid values for the sort_by parameter.Volume
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
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
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.
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:
The minimum reliable window is one full UTC day: YYYY-MM-DD 00:00:00 to YYYY-MM-DD 23:59:59. Windows shorter than a full UTC day 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
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
Type
Description
transaction_id
string
Transaction ID
timestamp
string
Click datetime (UTC, YYYY-MM-DD HH:MM:SS)
offer_id
number
Offer ID
offer_name
string
Offer name
affiliate_id
number
Affiliate ID
affiliate_name
string
Affiliate name
advertiser_id
number
Advertiser ID
advertiser_name
string
Advertiser name
campaign_id
number
Campaign ID (omitted if not set)
error_code
number
Error code (0 = no error)
error_message
string
Human-readable error description
is_unique
boolean
Whether this was a unique click
is_view_through
boolean
View-through attribution flag
is_test_mode
boolean
Whether sent in test mode
payout
number
Payout amount
revenue
number
Revenue amount
currency
string
Currency code
country
string
Country code
region
string
Region / state
city
string
City
browser
string
Browser name
platform
string
OS platform
device_type
string
Device type
os_version
string
OS version
user_ip
string
Client IP address
sub1–sub5
string
Affiliate sub parameters (omitted if empty)
source_id
string
Traffic source ID (omitted if empty)
referer
string
Referring URL (omitted if empty)
coupon_code
string
Coupon code (omitted if empty)
has_conversion
boolean
Whether this click resulted in a conversion
previous_transaction_id
string
Prior click transaction ID in redirect chain (omitted if not set)
