API referenceIntegrations

Get ClickFlare spend push

Returns the ClickFlare spend push setting of the brand and the outcome of the last push: when it ran, how many ClickFlare campaigns it updated, the last error and how many Koast campaigns with spend have no ClickFlare campaign mapped. Requires an organization owner or admin.

GET
/v1/brands/{brandId}/integrations/clickflare/push
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.

brandId*integer

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

Response Body

Get ClickFlare spend push

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

Whether a ClickFlare API key is connected to the brand.

enabled*boolean
disabledReason*|

Why Koast turned the push off itself: unauthorized (ClickFlare rejected the key) or refused (ClickFlare refused the cost upload).

lastPushAt*string|null
lastCampaignsPushed*number

ClickFlare campaigns whose spend for today the last cycle uploaded.

lastError*string|null
lastErrorAt*string|null
unmatchedCount*number

Koast campaigns with spend and no ClickFlare campaign mapped.

schedule*
curl -X GET "https://example.com/v1/brands/0/integrations/clickflare/push" \  -H "Authorization: Bearer koast_sk_..."
{  "brandId": 0,  "connected": true,  "enabled": true,  "disabledReason": "string",  "lastPushAt": "string",  "lastCampaignsPushed": 0,  "lastError": "string",  "lastErrorAt": "string",  "unmatchedCount": 0,  "schedule": {    "cron": "string",    "finalLocalHour": 0,    "requestIntervalSeconds": 0  }}

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