Adzuna Intelligence API
Home
Knowledge Base
About
Adzuna Intelligence API
  • Introduction
  • Access and Authentication
  • Taxonomies
  • Core Demand Data
  • Interest Quotient Data
  • Compensation Data
    • List job benefitsGET
    • Search job benefitsGET
    • Get mean and median salaryGET
    • Get mean and median salary over timeGET
    • Get salary distribution dataGET
    • Get benefits offeredGET
  • Location Data
  • Occupation Data
  • Industry Data
  • Skill Data
  • Education Data
  • Apprenticeship Data
  • Company and Employer Data
  • Public data
  • Complex Queries
logoPowered by Apidog
  1. Compensation Data

Get benefits offered

GET/api/v1.1/{country_code}/reports/hiring-benefits/

For postings matching the given criteria and time period, returns a list of job benefits being offered, ranked in order of number of postings advertising the benefit.

:::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: API Key
Add parameter in header
Authorization
Example
Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379
Path Params
country_code
string 
required

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

Example:
gb
Match pattern:
^[a-z]{2}$
Query Params
category_id
array[integer]
optional

A unique ID specifying an occupation sector/category.

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.

limit
integer 
optional

The maximum number of matches to return in a search.

>= 1<= 1000
Default:
10
location_id
array[integer]
required

A unique ID specifying a location/statistical area.

Example:
26
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

Responses

Request successful.(200)
Request successful.
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
sample_size
integer 
required

The total number of unique postings matching the request that offered at least one benefit.

>= 0
data
array[object (InDemandBenefitsOutputNested) {2}] 
required

A list of benefits offered, ranked by number of postings that offered the benefit.

benefit
object (JobBenefit) 
required

The benefit being offered.

posting_count
integer 
required

Number of matched postings that offered the benefit.

>= 0
Example
{
  "sample_size": 1234,
  "data": [
    {
      "benefit": {
        "id": 1,
        "name": "Pension Scheme"
      },
      "posting_count": 123
    }
  ]
}
Last modified: 4 months ago