COconvertflow
Reports

List campaigns with metrics

get/api/v1/reports/campaigns

Request

  • Base URL
    https://app.convertflow.co
  • Auth
    HTTP bearer

Query parameters

website_idinteger

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).

timeframe'today' | 'this_week' | 'this_month' | 'this_quarter' | 'this_year' | 'last_24_hours' | 'last_7_days' | 'last_30_days' | 'last_90_days' | 'last_365_days' | 'all_time' | 'insights_week' | 'custom'
range_startstring date

Required when timeframe=custom (ISO 8601)

range_endstring date
count_type'distinct' | 'total'

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.

previous_periodboolean

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.

pageinteger
per_pageinteger
sort'created_at' | 'published_at' | 'views' | 'conversions' | 'completions' | 'conversion_rate' | 'completion_rate' | 'revenue' | 'aov' | 'custom_goals' | 'bookings'
cta_typestring

Filter by campaign format.

status'live' | 'archived'

Response

count_type=total sums raw views

reportstring

Changes

No recorded changes to this operation across all 1 revision of this API.