Intelligence

Find peers

Find k-nearest-neighbour peers for an area by normalized signal values. A retired postcode resolves to the neighbourhood it was in; target.postcode_status and meta.warnings say so.

post/v1/peers

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/peers
  • Auth: HTTP bearer

Request body

signalsstring[]

Subset of signal dimensions to compare on.

country'England' | 'Wales' | 'Scotland'
ladstring
cohortstring

Slug of one of your org's cohorts: candidates are limited to its members.

cohort_idstring

The same, by cohort id. Use one of cohort or cohort_id.

Example request

{
  "target": {
    "postcode": "SW1A 1AA"
  },
  "k": 10
}

Response

Default Response

Changes

No recorded changes to this operation across all 2 revisions of this API.