geogrid_status
Poll a geogrid_scan job_id to check if a long-running local ranking grid scan is pending, running, complete, or failed, and retrieve the full grid once ready.
Instructions
Collects the grid from a geogrid_scan that returned a job_id instead of a result. FREE -- poll as often as you need.
Returns status "pending" or "running" while the grid is being searched, "complete" with the full grid once done, and "failed" with an error if the scan died (it is refunded). Most scans finish inside geogrid_scan itself and never need this; a scan that runs long is the one that does.
Points that could not be checked have status "error" in grid_points, are counted in failed_points, and are refunded.
READING THE GRID: grid is a 2D array where 0 means the business was not found at that point, not that it ranked zero. average_rank and found_in count only the points where it WAS found, so a strong average_rank across a low found_in means the business ranks well in a small area and is invisible outside it -- which is the finding a geogrid exists to produce.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | The job_id geogrid_scan returned instead of a grid. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| atrp | No | ||
| grid | No | ||
| solv | No | ||
| zoom | No | ||
| error | No | ||
| total | No | ||
| cached | No | ||
| center | No | ||
| job_id | Yes | ||
| status | Yes | ||
| keyword | No | ||
| warning | No | ||
| found_in | No | ||
| place_id | No | ||
| progress | No | ||
| grid_size | No | ||
| zoom_mode | No | ||
| grid_points | No | ||
| average_rank | No | ||
| completed_at | No | ||
| radius_miles | No | ||
| total_points | No | ||
| business_name | No | ||
| failed_points | No | ||
| credits_refunded | No |