Propose KPI target
Records a KPI target the user stated, for the active brand, as a proposal (status INFERRED).
Tool name: propose-kpi-target.
Records a KPI target the user stated, for the active brand, as a proposal (status INFERRED). It is not in force until a person confirms it in Koast, and you cannot confirm it. It replaces an earlier proposal for the same metric, and is refused when that metric already has a confirmed target: the user changes those in Koast. Money targets take the brand's currency.
When to use
When the user tells you a target they aim for, such as a cost per purchase or a return on ad spend. Afterwards tell them it stays a proposal until they confirm it in Koast.
Access
| Property | Value |
|---|---|
| Required scope | write |
| Publishes | No |
| Read-only | No |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
| Field | Type | Required | Description |
|---|---|---|---|
metric | string | Yes | The metric the target is about, in the same names automations use, for example CPA, ROAS, COST_PER_RESULT, CTR or REVENUE. One of SPEND, COST_PER_RESULT, PURCHASE_ROAS, WEBSITE_PURCHASE_ROAS, MOBILE_APP_PURCHASE_ROAS, OFFLINE_PURCHASE_ROAS, CTR, CLICKS, CONVERSIONS, CPC, REVENUE, CPA, ROI, ROAS, CVR, RPC, AOV, PROFIT, MARGIN. |
satisfiedWhen | string | Yes | GREATER_THAN when the user wants the result above the value (ROAS, revenue, CTR); LESS_THAN when below it (CPA, cost per result, CPC). One of GREATER_THAN, LESS_THAN. |
valueType | string | Yes | CURRENCY for a money amount; PERCENTAGE for a percentage; DECIMAL for a ratio such as ROAS; INTEGER for a count. One of PERCENTAGE, DECIMAL, INTEGER, CURRENCY. |
value | number | Yes | The target. For CURRENCY, the amount in the brand's own currency as the user said it, for example 45.5; Koast converts it and refuses more decimals than the currency has. For PERCENTAGE, 2.5 means 2.5%. |
dataSource | string | No | Where the metric is measured. Default META, the ad platform's own reporting; HYROS, COMETLY, REDTRACK or CLICKFLARE when the user judges results by that tracker. One of META, REDTRACK, COMETLY, HYROS, CLICKFLARE. |
timeRange | string | No | The window the metric is judged over. Default LAST_7_DAYS. One of TODAY, YESTERDAY, LAST_2_DAYS, LAST_3_DAYS, LAST_7_DAYS, LAST_14_DAYS, LAST_28_DAYS, LAST_30_DAYS, LIFETIME. |
attributionWindow | string | No | The attribution window. Default DEFAULT, the ad account's own setting. One of DEFAULT, ONE_DAY_CLICK, ONE_DAY_VIEW, SEVEN_DAY_CLICK, SEVEN_DAY_VIEW, TWENTY_EIGHT_DAY_CLICK, TWENTY_EIGHT_DAY_VIEW. |
note | string | No | What the user said, in a few words. At most 500 characters. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
target | object | Yes |
REST equivalent
MCP only. No REST operation does the same thing.
Preview ads
Preview a campaign launch's ads as they appear in feed: primary text, headline, call to action and the creative image for every ad in the launch, in structure order.
Record business economics
Records the business numbers the user told you in chat for the active brand: average order value, gross margin rate, fulfilment cost per order and payment fee rate.