Element performance + field/product breakdown
Request
- Base URLhttps://app.convertflow.co
- AuthHTTP bearer
Query parameters
Website id. Must be one of the token's websites. Optional for single-website tokens (derived from the binding); required when the token grants multiple websites (400 website_id_required otherwise).
Required when timeframe=custom (ISO 8601)
Count mode for the funnel metrics (views, conversions, completions, subscribes, submissions, bookings, custom goals). distinct = unique visitors via HyperLogLog (default); total = raw event count. Orders and revenue are always summed regardless. Ignored on timeframe=insights_week (the weekly snapshot stores distinct counts only). An unrecognized value returns 422 invalid_count_type.
When true, each metrics block gains a nested previous object (same shape, for the immediately preceding period of equal length) and a changes object with the percent change per metric (null when the prior value is unavailable). The compared window is echoed as previous_range_start/previous_range_end in the timeframe block. No effect on timeframe=all_time (no prior period) or timeframe=insights_week.
When set, the response gains a timeseries object alongside metrics: one point per bucket over the same window, each with date, views, conversions, completions, subscribes, submissions, orders and revenue (points carry submissions even where the metrics block does not). Buckets with no activity are returned as zeroes. Under the default count_type=distinct each bucket counts unique visitors within that bucket, so the points do not sum to the headline total (a visitor active on three days counts once overall and three times across the daily points); use count_type=total when the buckets must reconcile. An unrecognized value returns 422 invalid_group_by. On the website report the window may cover at most 92 days (campaign, variant, step and element reports take any range); a range that would exceed 400 points is rejected too. Both return 422 range_too_wide.
Response
count_type=total sums raw views
Changes
No recorded changes to this operation across all 1 revision of this API.