Get an advanced search
get_advanced_searchOne advanced search: status, leads so far, progress by keyword, its top places and the newest batch running now.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaign_id | Yes | An id from run_advanced_search or list_advanced_searches. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | No | ||
| leads | No | Unique leads charged so far. | |
| places | No | How many places it searches. | |
| status | Yes | running | paused | completed | stopped. Paused by itself when a Free account runs out of leads (they don't renew: upgrade, then resume). | |
| estimate | No | { expected_leads, low, high, minutes } as estimated when it started. | |
| keywords | No | Each { keyword, exact }. | |
| lead_cap | No | ||
| resume_at | No | When a waiting search carries on by itself. | |
| by_keyword | No | Each { keyword, exact, category, searches, searches_done, leads }. | |
| created_at | No | ||
| leads_with | No | How to read its leads: query_leads or export_leads with campaign_id. | |
| top_places | No | Each { place, leads, basis }: basis "leads" — leads delivered there; or basis "businesses_checked" — leads null and businesses_checked the businesses checked there, when leads per place are not known. | |
| finished_at | No | ||
| running_now | No | The newest batch running now: { keyword, places, status, verified, of } — places is the batch's place names. | |
| finish_reason | No | all_searched | lead_limit | stopped once finished; null while it runs. | |
| searches_done | No | ||
| status_detail | No | One sentence on where it is — e.g. waiting for the daily city budget, and until when, or why it was paused. | |
| searches_total | No | Keywords × places. |