v1
latestOpenAPI 3.0.12026-08-06241391671.8 KBReturns dry run report for testing campaign configuration.
Path parameters
Campaign ID
Query parameters
Free-text substring search over NAME columns only (campaignName, offerName, ...). NOT for ids and NOT exact — a fragment can match several rows or none. To scope a report to a specific entity by id, use the drilldown filters filter1/filter1Value (e.g. filter1=campaignId, filter1Value=<id>); never put an id here.
Time zone for date aggregation, e.g. 'America/New_York', 'Europe/Warsaw', or 'Etc/GMT'. Default: Etc/GMT. Affects how day, dayOfWeek, and hourOfDay boundaries are calculated.
Columns to include in the response. Repeated query parameter — use column=visits&column=clicks, NOT comma-separated.
Volume: visits, clicks, conversions, impressions, uniqueVisits, uniqueClicks
Financial: revenue, cost, profit
Rate/efficiency metrics (with formulas):
| Column | Formula | Note |
|---|---|---|
| ctr | clicks / visits | Lander effectiveness. Always 0 for direct-linking campaigns |
| cr | conversions / clicks | Offer quality. Always 0 for direct-linking campaigns |
| cv | conversions / visits | End-to-end funnel. The only rate metric valid for both lander and direct-linking |
| roi | (revenue-cost) / cost | Percentage, e.g. 125.0 = 125% ROI |
| cpa | cost / conversions | Cost per acquisition |
| epv | revenue / visits | Earnings per visit |
| epc | revenue / clicks | Always 0 for direct-linking campaigns |
| cpv | cost / visits | Cost per visit |
| cpc | cost / clicks | Cost per click |
Other rate metrics: ecpa, ecpc, ecpm, cpm, ap, rpm, sctr, ictr, viewRate
Quality: suspiciousVisits, suspiciousClicks, robotVisits
Entity names: campaignName, offerName, landerName, trafficSourceName, affiliateNetworkName, countryName, deviceName, connectionTypeName, languageName, flowName
Custom: customConversions1-20, customRevenue1-20 (discover via GET /custom-conversions). User-defined derived metrics (discover via GET /custom-columns).
No Name variant for self-labeling dimensions: region, city, os, osVersion, browser, browserVersion, isp, mobileCarrier, referrerDomain are already human-readable — there is no regionName/cityName/osName/browserName column, and requesting one returns 400. (Code/name pairs like countryCode/countryName and connectionType/connectionTypeName are the exception — those Name columns do exist.)
Tags: the tag column is campaignTags (also offerTags, landerTags) — plain tags is not a column.
To discover all available columns at runtime, call GET /column/info.
Response
Aggregated report data.