Check a report run
get_report_statusCheck if a report started with run_report has finished by passing its report_id, then use the returned status to decide whether to wait or retrieve the results.
Instructions
Check whether a report started with run_report has finished. Reading is free. A full report takes about 10 to 20 minutes.
POLL NO MORE OFTEN THAN EVERY 30 SECONDS. Each call is counted against your API allowance and the report cannot finish faster; tell the user it is running and check again later instead of calling in a loop.
Args:
report_id (string, required): the report_id from run_report
Returns JSON: { data: { report_id, status, finished, message, ... } }. status: "processing" (still running), "completed", "no_competitors" (finished: a profile of the product alone), or "no_rivals" (stopped before any research because no competitor could be counted as a rival; no credits were used). The API does not report a percentage: status is all there is. When finished is true the result names the next call: get_report with the report_id.
Use when: "is my report ready?" after run_report.
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": {
"report_id": "<report_id>"
},
"name": "get_report_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes | The report_id returned by run_report (or an id from list_reports) |