API referenceIntegrations

Get ClickFlare settings

Returns the ClickFlare connection of the brand: the masked API key, the ClickFlare account timezone and currency, the workspaces Koast reads, which trackingField1..20 carries the campaign, ad set and ad ids (and how each was chosen), and the outcome of the last report pull. Answers 404 when ClickFlare is not connected. Requires an organization owner or admin.

GET
/v1/brands/{brandId}/integrations/clickflare/settings

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

Get ClickFlare settings

application/json
  1. response
brandId*number
connected*boolean

Whether a ClickFlare API key is connected to the brand.

maskedApiKey*string|null
timezone*|

The ClickFlare account timezone used for reports. Null means UTC is used.

currency*string|null
workspaceIds*array<string>
trackingFields*
trackingFieldsSource*

How each tracking field was chosen: data (matched Koast ids in ClickFlare traffic), traffic_source (the traffic source template), or manual.

lastPullAt*string|null
lastPullError*string|null
lastPullRows*number|null
curl -X GET "https://example.com/v1/brands/0/integrations/clickflare/settings" \  -H "Authorization: Bearer koast_sk_..."
{  "brandId": 0,  "connected": true,  "maskedApiKey": "string",  "timezone": "string",  "currency": "string",  "workspaceIds": [    "string"  ],  "trackingFields": {    "campaign": "string",    "adset": "string",    "ad": "string"  },  "trackingFieldsSource": {    "campaign": "data",    "adset": "data",    "ad": "data"  },  "lastPullAt": "string",  "lastPullError": "string",  "lastPullRows": 0}

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

Update ClickFlare spend push

Turns the spend push into ClickFlare on or off. When on, Koast uploads the spend of every mapped ClickFlare campaign for today every hour, and yesterday's final spend once after midnight in the ad account timezone. Each upload replaces the cost ClickFlare holds for that window. ClickFlare accepts USD only. ClickFlare must be connected and a campaign tracking field set first. Requires an organization owner or admin.

Update ClickFlare settings

Changes the ClickFlare workspaces Koast reads and overrides the tracking fields that carry the ad platform campaign, ad set and ad ids. Only the fields sent change. A tracking field set here is marked manual and is never replaced by detection; null clears it. Requires an organization owner or admin.