Refresh keyword metrics
refresh_keyword_metricsRe-fetches monthly volume, difficulty, CPC and the opportunity score of one keyword, plus up to 49 companion keywords of the same website and locale, from the search-volume provider in a single call. Keywords the provider does not return are left untouched. Use it when metrics look stale (see metrics_updated_at); it does not change Google Search Console positions. Costs 1 AI brain credit, charged before the work, refunded if the provider fails. Requires an active subscription or free trial. Pass confirm=true to acknowledge the AI brain credits charge; without it the tool only returns the cost and your balance. Pass website_id when the account has several websites (see get_account).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Set to true to acknowledge the AI brain credit charge. Omit it to only get the cost and your balance. | |
| keyword_id | Yes | Keyword id from list_keywords. | |
| website_id | No | Website id from get_account. Optional when the account has a single website. | |
| companion_keyword_ids | No | Up to 49 other keyword ids to refresh in the same call. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| website_id | No | Website the result belongs to. | |
| credits_balance | No | Current AI brain credits balance; only with requires_confirmation. | |
| refreshed_count | No | ||
| credits_required | No | AI brain credits the call would charge; only with requires_confirmation. | |
| credits_balance_after | No | AI brain credits balance after this call. | |
| requires_confirmation | No | Present when the tool did not run: it needs confirm=true. The other fields are then absent. |