Get interest quotient
GET
/api/v1.1/{country_code}/reports/interest-quotient/Returns the interest quotient for postings matching the given criteria over the given time period.
In addition to the interest quotient value (returned as interest_quotient
), an high/average/low indication is returned (interest_quotient_level
). This indicates whether the number is high, medium or low compared to the average across all values of the primary facet, in the given location and time period.
For example, if you query the interest quotient figure for a particular occupation, and the value of interest_quotient_level
is "High", this means that the interest quotient for this particular occupation is high compared to the average for all occupations in the given location and time period.
:::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.
:::
Request
A two character code that specifies which country dataset to query.
A unique ID specifying an occupation sector/category.
A unique ID specifying a company/employer.
The end date of the desired time period for the query. Must be specified in ISO8601 format (YYYY-MM-DD).
A unique ID specifying an industry.
A unique ID specifying a location/statistical area.
A unique ID specifying an occupation (job title). If specified, an occupation_taxonomy_id must also be provided.
A unique ID specifying an occupation taxonomy. Required when specifying an occupation_id.
A unique ID specifying a skill.
A unique ID specifying a skill tag (pre-defined group of skills).
The start date of the desired time period for the query. Must be specified in ISO8601 format (YYYY-MM-DD).
Request samples
Responses
The interest quotient for postings matching the query.
Specifies whether the interest quotient is high, average or low compared to the average across the primary facet.