COconversion

Export Campaigns

Export of every campaign: custom and blast campaigns, webinars, and field events. Each call returns one page; follow pagination.nextCursor until it is null to read the full set. Ad campaigns are not exported.

Request access. This endpoint is not enabled by default, contact the Conversion team to request access. Calls from accounts without it return 403 export_not_enabled.

post/v2/exports/campaigns

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Request body

categoriesstring[]

Only campaigns of these categories.

campaignTypeIdsstring[]

Only campaigns of these campaign types. At most 100.

includeArchivedboolean

Include archived rows. Defaults to true.

cursorstring

The opaque cursor returned as pagination.nextCursor by a previous call. Omit it on the first page. Send it without filters, because the cursor carries them; sending both returns invalid_filter.

limitinteger

The maximum number of rows per page. Defaults to 50. Values are clamped to [1, 100].

Example request

{
  "cursor": "eyJ2IjoxLCJmIjp7fSwiayI6ImFiYyJ9"
}

Response

A page of campaigns retrieved successfully.

Changes

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