Get account overview

Rolls up spend and results across the Koast launches on the ad account for datePreset (default today). Campaigns not launched through Koast are not counted, and at most 10 launches are sampled. Values are live reads from the ad platform.

GET

/v1/brands/{brandId}/ad-accounts/{accountId}/overview

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.

accountId*string

The ad account id (act_… on Meta, biz_… on Whop).

Query Parameters

datePreset?string

Reporting date preset. If omitted, defaults to today. Use last_7d / last_28d / last_30d / last_90d / this_month / last_month as needed. Every last_Nd preset ENDS YESTERDAY and does not include today, so a campaign that only started yesterday reads as zero under last_7d, use today or yesterday to see it, and say which window a number came from. For "lifetime" / "all time" / "since launch", use maximum, NOT "lifetime" (it is not an accepted value). Arbitrary start/end date ranges are not supported by the backend.

Value in"today""yesterday""this_week_sun_today""last_7d""last_14d""last_28d""last_30d""last_90d""this_month""last_month""maximum"

Response Body

Get account overview

application/json

response

asOf?string

ISO time of the live provider read behind this response. Set on MCP and API responses, which may be served from the short metrics cache.

[key: string]?unknown

curl -X GET "https://example.com/v1/brands/0/ad-accounts/string/overview" \  -H "Authorization: Bearer koast_sk_..."

{  "asOf": "string",  "property1": null,  "property2": null}

Required scope: read. CLI: koast get-account-overview, see Ad Accounts commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.