Get account overview
Roll up spend and results across the Koast batches on an ad account, NOT the whole ad account: campaigns that were never launched through Koast are not counted, and at most 10 batches are sampled (the payload reports batchesSampled).
Tool name: get-account-overview.
Roll up spend and results across the Koast batches on an ad account, NOT the whole ad account: campaigns that were never launched through Koast are not counted, and at most 10 batches are sampled (the payload reports batchesSampled). For a true account-wide figure, or for campaigns launched outside Koast, use listAccountCampaigns. Pass accountId explicitly when account scope was resolved via listMyAdAccounts (multi-account / all-accounts dashboard); omit only when a single account is already locked-in by the dashboard context.
When to use
Rollup of the Koast batches on an account. Use for "how are my Koast launches doing". A $0.00 here means no Koast batch has delivery in the window, not that the account is idle, check listAccountCampaigns before telling the user the account is spending nothing. NOT for per-campaign drill-down, use getMetrics.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | No | Ad account id (e.g. act_1234 on Meta). Required when no single account is locked in context, get it from listMyAdAccounts. |
datePreset | string | No | 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. One of today, yesterday, this_week_sun_today, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month, maximum. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
asOf | string | No | 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. |
REST equivalent
GET /v1/brands/{brandId}/ad-accounts/{accountId}/overview, Get account overview. CLI: koast get-account-overview.