Scan a tracked competitor
scan_competitorRequests one immediate check for new ads from a competitor that is already tracked; get_tracking_status shows when it finishes. Two steps: without confirm it returns a preview with idempotency_key; the same call with confirm: true, that key and max_credits: 0 starts the scan. It runs under the existing tracking month and does not start or renew tracking. Refused when tracking is off or paused, when a scan is already queued or running, and within one hour of the last manual scan.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"competitor_id": "<competitor_id>"
},
"name": "scan_competitor"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | true starts the scan described by the preview. Absent or false returns the preview and changes nothing. | |
| max_credits | No | 0 with confirm: true: a scan carries no new charge and cannot approve a renewal. | |
| competitor_id | Yes | Competitor id from list_competitors. | |
| idempotency_key | No | idempotency_key from the cost preview, needed with confirm: true and valid for 15 minutes. A repeat with the same key returns the first result without a second charge. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | next value in this response. | |
| status | No | Current progress or delivery state. | |
| replayed | No | replayed value in this response. | |
| billing_url | No | billing url value in this response. | |
| max_credits | No | Explicit credit ceiling to echo after the user approves this quote. | |
| cost_credits | No | Credits quoted or charged by this operation. | |
| what_happens | No | Plain explanation of the proposed work, confirmation steps and quote expiry. | |
| enough_credits | No | enough credits value in this response. | |
| balance_credits | No | balance credits value in this response. | |
| idempotency_key | No | Key binding confirmation to this preview and preventing duplicate work. | |
| confirmation_required | No | True for a cost preview awaiting explicit approval. |