List ClickFlare campaign mappings

Returns the campaign mappings used by the ClickFlare spend push: automatic ones derived from the ClickFlare traffic of the last days (the campaign tracking field), manual ones, the Koast campaigns with spend that have no mapping (with the reason), and the ClickFlare campaigns to pick from. Requires an organization owner or admin.

GET

/v1/brands/{brandId}/integrations/clickflare/mappings

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

Response Body

List ClickFlare campaign mappings

application/json

response

brandId*number

mappings*array<>

unmatched*array<>

clickflareCampaigns*array<>

curl -X GET "https://example.com/v1/brands/0/integrations/clickflare/mappings" \  -H "Authorization: Bearer koast_sk_..."

{  "brandId": 0,  "mappings": [    {      "providerCampaignId": "string",      "koastCampaignName": "string",      "provider": "string",      "cfCampaignId": "string",      "cfCampaignName": "string",      "source": "auto",      "pushable": true,      "skipReason": "clickflare_campaign_missing",      "updatedAt": "string",      "updatedByUserId": 0    }  ],  "unmatched": [    {      "providerCampaignId": "string",      "koastCampaignName": "string",      "provider": "string",      "reason": "ambiguous",      "candidates": [        {          "cfCampaignId": "string",          "cfCampaignName": "string",          "visits": 0        }      ]    }  ],  "clickflareCampaigns": [    {      "id": "string",      "name": "string"    }  ]}

Required scope: read. CLI: koast list-clickflare-campaign-mappings, see Integrations commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.