Get metrics
Get performance metrics at campaign / adset / ad level for the current launch.
Tool name: get-metrics.
Get performance metrics at campaign / adset / ad level for the current launch. Pass level to scope the request; optionally pass id to scope to a specific entity or omit for all. Returns impressions, clicks, spend, CTR, CPC, conversions and per-level collections.
When to use
Performance totals at campaign / adset / ad level (impressions, clicks, spend, CTR, CPC, conversions). The unified metrics tool, pass level to scope. NOT for daily breakdowns (use getInsightsDaily) or fatigue scoring (use computeCreativeFatigue).
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
campaignLaunchId | string | Yes | Campaign launch ID (a.k.a. batch ID). Read it from the Current Context block when one is in scope, or resolve it from a mention via listAccountCampaigns / the campaign tree when the user @-mentioned a different launch. |
level | string | Yes | Which level to pull metrics at. One of campaign, adset, ad. |
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. |
id | string | No | Optional entity id to scope to. Omit for all entities at this level. |
Output
The tool catalog does not declare an output schema for this tool.
REST equivalent
GET /v1/brands/{brandId}/launches/{launchId}/metrics, Get metrics. CLI: koast get-metrics.