Run rank check
run_rank_checkRun a provider-backed rank check for one keyword to measure search position, with cost caps and immediate or queued results.
Instructions
Run a provider-backed rank check for one keyword. Requires write access and may incur provider cost. Ask for explicit user approval immediately before calling; this server cannot enforce the client's confirmation UI. The deployment selects inline or queued execution. A queued response contains an rcr_ run ID, not a check_ ID. Follow get_rank_history for that run_id until terminal, then use its check_ ID with get_rank_check_result. The async option only requests an early response. Set max_cost_cents to have the server refuse the check when its preflight estimate is higher.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| async | No | ||
| keyword_id | Yes | Identifier of the tracked keyword to operate on. | |
| project_id | No | Identifier of the bisibility project to operate on; list_projects returns valid project ids. | |
| provider_id | No | SERP provider id, validated server-side. Known values: dataforseo and serpapi. | |
| max_cost_cents | No | Server-enforced maximum for the preflight cost estimate of this check, in cents. | |
| idempotency_key | No |