COconvertflow
Campaigns

List campaigns

Returns the website's campaigns as configuration (name, format, archived/live state, landing-page settings, remix instructions, variant traffic split) — 25 per page, newest first, archived included. For performance metrics use /api/v1/reports/campaigns instead. Requires the campaigns:read scope on OAuth tokens.

get/api/v1/campaigns

Request

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

Query parameters

status'active' | 'archived'

Filter to active (non-archived) or archived campaigns

pageinteger

Response

campaigns returned

idinteger
namestring
cta_typestring

Campaign format

format_typestring nullable

Campaign sub-format. Null for page and bar campaigns, which have none.

archivedboolean
liveboolean

Whether visitors can reach the campaign: the live toggle for popups, hooks, bars and embeds; not archived for landing pages.

buildingboolean
build_failedboolean
test_typestring
page_pathstring
domain_idunknown
meta_titleunknown
meta_descriptionunknown
open_graph_titleunknown
open_graph_descriptionunknown
open_graph_imageunknown
seo_indexunknown
experiment_start_dateunknown
experiment_end_dateunknown
experiment_metricunknown
remixobject
published_atunknown
created_atstring date-time
updated_atstring date-time

Changes

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