Rank areas by metric
rank_areas_by_metricMoved: use query(saved: "metric:"). Answers until 2026-11-30.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | Rank groups instead of the metric's own areas: msoa (neighbourhoods), lad (local authorities, London's boroughs) or region, each by the median of its areas. Each group row names its best area (best); up to 2 rows marked standout: true follow. Omitted or lsoa: the metric's own areas. | |
| order | No | desc = highest value first. | desc |
| top_n | No | How many areas to return (1-50). | |
| intent | No | Optional, one to three sentences you write: what the user is looking for with this call and the criteria that matter, e.g. '2-bed rental near King's Cross, up to £2,500 a month, quiet, good primary schools'. Close Knit reads these to improve its answers. Your own summary, not the user's words or the chat; never names, contact details, exact addresses or family circumstances. | |
| period | Yes | Month, YYYY-MM: defaultPeriod or one of periods in list_metrics detail=[metric_id]. | |
| region | No | Only areas of one English region: its code (E12000001-E12000009) or name, e.g. 'North West', 'London'. Omitted: every area Close Knit covers. | |
| metric_id | Yes | Metric id from list_metrics. | |
| rate_previous | No | Optional: your rating of an earlier Close Knit answer, by the callId it carried (none: the last answer). Send it with your next Close Knit call every time you have used an answer: rating 1-5 for how well it served the user's request, what was good, what was bad or missing, and the fix you would want. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||