Resolve a location
resolve_locationTurns free text such as 20 miles of Leeds, Yorkshire or LS1 into region, county, town, postcode or radius filters, each with a count and a ready filter. Ambiguous places come back as candidates with a question, so ask the user which they meant rather than choosing. Free and needs no account, though a radius under 5 miles needs an account. Add the chosen filter to the audience, then call count_audience. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Free text such as "20 miles of Leeds", "Yorkshire" or "SW1". | |
| dataset | No | The dataset an audience draws from. uk_contacts is live; ie_contacts and global_contacts are listed but not yet served. | |
| radius_miles | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | ||
| question | Yes | ||
| ambiguous | Yes | True when more than one candidate fits; ask the person which they meant. | |
| candidates | Yes | ||
| disclosure | Yes |