Estimate an advanced search
estimate_advanced_searchWhat an advanced search (many keywords across many places) would find and how long it would take — without starting it or spending anything. expected_leads is the most likely number of unique leads (each business is charged once however many keywords or places find it); low–high is the range it lands in most of the time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Optional name, up to 80 characters. | |
| places | No | Single places by name ('Austin'), 'name, region' when a name is in several ('Springfield, Illinois'), or code (find_places). Up to 25,000 regions and places together; keywords × places may come to at most 50,000 searches. | |
| country | No | 'US' (the default), or a US territory's code ('PR', 'GU', 'VI', 'AS', 'MP') with a place from find_places. | |
| regions | No | Whole US states, by name or code (find_places). | |
| keywords | Yes | What to search for: up to 20 keywords or Google categories, each up to 100 characters. Each a string, or { keyword, exact } where exact keeps only businesses whose main Google category is that one. | |
| lead_cap | No | Stop after this many unique, charged leads: a whole number from 100 to 1,000,000. Omit to search every place. | |
| everywhere | No | Every place in the US (or in the territory sent as country). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| low | No | ||
| high | No | ||
| time | No | How long it would take, waits for the daily city budget included. | |
| places | No | ||
| country | No | ||
| keywords | No | Each { keyword, exact }, as they would run. | |
| searches | Yes | Keywords × places. | |
| next_step | No | ||
| charged_leads | No | Leads expected to be charged: expected_leads, capped by lead_cap. | |
| expected_leads | Yes | ||
| paced_by_daily_budget | No | True when the account's daily city budget, not the searching, sets the time. | |
| campaign_searches_per_day | No | Places a day advanced searches may use on this plan. |