Compare location quotient across geographic areas

For a given geographic area type and criteria, returns the location quotient value and level for all geographic areas of the given type.

This data is commonly used to populate geographic heat maps (chloropleth maps).

INFO

This endpoint allows querying by one primary facet type (location, occupation, skill, industry, employer) only. Multiple values of the same facet may be provided, in which case, they will be aggregated.

For more complex queries over multiple facets, see Perform complex boolean queries

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

country_code

string

required

A two character code that specifies which country dataset to query.

Example:

Match pattern:

^[a-z]{2}$

Query Params

category_id

array[integer]

optional

A unique ID specifying an occupation sector/category.

Example:

company_id

array[integer]

optional

A unique ID specifying a company/employer.

end_date

string <date>

required

The end date of the desired time period for the query. Must be specified in ISO8601 format (YYYY-MM-DD).

Example:

2022-01-31

industry_id

array[string]

optional

A unique ID specifying an industry.

location_type_id

integer

required

A unique ID specifying a type of location/statistical area.

Example:

occupation_id

array[integer]

optional

A unique ID specifying an occupation (job title). If specified, an occupation_taxonomy_id must also be provided.

occupation_taxonomy_id

integer

optional

A unique ID specifying an occupation taxonomy. Required when specifying an occupation_id.

>= 1

skill_id

array[integer]

optional

A unique ID specifying a skill.

skill_tag_id

array[integer]

optional

A unique ID specifying a skill tag (pre-defined group of skills).

start_date

string <date>

required

The start date of the desired time period for the query. Must be specified in ISO8601 format (YYYY-MM-DD).

Example:

2022-01-01

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Request successful.

application/json

Body

array of:

location

object (Area)

required

A specific location/statistical area.

integer

read-onlyrequired

The unique ID of the location / statistical area.

name

string

required

The name of the location / statistical area.

<= 128 characters

code

string

required

The official government code for the location / statistical area.

<= 16 characters

type_id

integer

read-onlyrequired

The unique ID of the location / statistical area type for this location / statistical area.

country_id

integer

read-onlyrequired

The unique ID of the country to which this location / statistical area belongs.

>= -2147483648<= 2147483647

location_quotient

number <double>

required

The location quotient value for postings matching the criteria in this location/statistical area.

location_quotient_level

enum<string>

required

An indication of whether location quotient value is high, average, or low compared to all locations/statistical areas of the specified type.

Allowed values:

LowAverageHigh

Example

[
  {
    "location": {
      "id": 20,
      "name": "North East (England)",
      "code": "TLC",
      "type_id": 20,
      "country_id": 1
    },
    "location_quotient": 1.08,
    "location_quotient_level": "Average"
  }
]