Status Page
API Reference

Request Parameters - Distributions

Distributions Request Parameters

Detailed reference for all supported Job Postings - UK Distributions request parameters, including property descriptions, supported operators, data types, and usage guidelines.

PropertyDescription
filter
  • Add filters to your postings query.
  • An object or a list of up to 10 objects.
filter.title
  • Filter by job title codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering
Example: ["53.30837"]
filter.active_sources_info
  • Filter postings by active sources information.
  • This is an optional attribute.
  • Source information for where the posting can be found online.
filter.active_sources_info_type
  • Choose the source type to filter by.
  • This is an optional attribute.
    Example: "Company"
filter.active_sources_info_source
  • Choose the source to filter by.
  • This is an optional attribute.
    Example: "ABCRecruiting.com"
filter.active_sources_info_url
  • Choose the source url to filter by.
  • This is an optional attribute.
    Example: "ABCRecruiting.com/job/GNkBaDoMWiyQbmlpFHfz"
filter.city
  • Filter by city IDs.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["TG9uZG9u"]
filter.city_name
  • Filter by city names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["London"]
filter.company
  • Filter by normalized company codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["NC95f2bd68-11c7-4140-92ab-7b82fd2d9f7e"]
filter.company_v2
  • Filter by normalized company v2 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["100136425"]
filter.company_is_staffing
  • Filter to or exclude postings from staffing companies.
  • This is an optional attribute.
  • Passing false filters out postings from companies that have been identified as staffing companies or recruiting agencies; true limits results to only those from staffing or recruiting companies. By default both staffing and non-staffing companies are included in the results.
    Example: true
filter.company_name
  • Filter by company names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering
    Example: ["Microsoft"]
filter.company_name_v2
  • Filter by company v2 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Glenholme Healthcare Group Limited"]
filter.contract_type
  • Filter by normalized contract type codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["10"]
filter.contract_type_name
  • Filter by normalized contract type names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Apprenticeship"]
filter.country
  • Filter by abbreviated country codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["ENG"]
filter.country_name
  • Filter by country names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["England"]
filter.edulevels
  • Filter by normalized education level codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [0]
filter.edulevels_name
  • Filter by normalized education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["High school or GED"]
filter.isced
  • Filter by ISCED education level codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [6]
filter.isced_max
  • Filter by maximum ISCED education level codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [7]
filter.isced_max_name
  • Filter by maximum ISCED education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Master's or equivalent level"]
filter.isced_min
  • Filter by minimum ISCED education level codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [5]
filter.isced_min_name
  • Filter by minimum ISCED education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Short-cycle tertiary education"]
filter.isced_name
  • Filter by ISCED education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Bachelor's or equivalent level"]
filter.employment_type
  • Filter by employment type (Full/Part time) codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [1]
filter.employment_type_name
  • Filter by employment type (Full/Part time) names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Full-time (> 32 hours)"]
filter.is_apprenticeship
  • Filter by apprenticeship job postings.
  • This is an optional attribute.
  • Job postings that are described as apprenticeship positions.
    Example: true
filter.is_internship
  • Filter by internship job postings.
  • This is an optional attribute.
  • Job postings that are described as internship positions.
    Example: true
filter.is_voluntary
  • Filter by voluntary job postings.
  • This is an optional attribute.
  • Job postings that are described as voluntary positions.
    Example: true
filter.keywords
  • Filter postings by keyword.
  • This is an optional attribute.
filter.keywords_type
  • Type of keyword search to run.
  • This is an optional attribute.
  • How the keyword(s) are matched in a job posting.
  • or - Match postings with any of the keywords.
  • and - Match postings with all the keywords.
  • phrase - Match postings with the keywords as a phrase.
  • expression - Match postings using a complex boolean expression; e.g. "(uav OR drone) AND agriculture NOT surveillance".
  • Alternatively, you can prefix a word with - to exclude it; e.g. "games Android -iOS" would match postings that mention 'games' and 'Android' but exclude those that mention 'iOS'.
  • Must be one of these values: "or", "and", "phrase", "expression"
    Default: "or"
filter.keywords_query
  • Keyword(s) by which to filter postings.
  • Keyword(s) to match in the original title and body of the job postings.
    Example: "work/life balance"
filter.lau1
  • Filter by Lightcast LAU1 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["00FY"]
filter.lau1_name
  • Filter by Lightcast LAU1 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Nottingham"]
filter.lot_career_area
  • Filter by career area ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["27"]
filter.lot_career_area_name
  • Filter by career area names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Marketing and Public Relations"]
filter.lot_occupation
  • Filter by occupation ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["271210"]
filter.lot_occupation_group
  • Filter by occupation group ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["2712"]
filter.lot_occupation_group_name
  • Filter by occupation group names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Marketing Specialists"]
filter.lot_occupation_name
  • Filter by occupation names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["E-Commerce Analyst"]
filter.lot_specialized_occupation
  • Filter by specialized occupation ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["27121011"]
filter.lot_specialized_occupation_name
  • Filter by specialized occupation names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["E-Commerce Assistant"]
filter.max_edulevels
  • Filter by maximum education level ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["3"]
filter.max_edulevels_name
  • Filter by maximum education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Master's degree"]
filter.max_salary
  • Filter by maximum advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the maximum advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.max_salary_lower_bound
  • Lower bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 55000
    Minimum 0
filter.max_salary_upper_bound
  • Upper bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 80000
    Minimum 0
filter.max_years_experience
  • Filter on the maximum years of experience requested in a posting.
  • This is an optional attribute.
  • This filter operates on the advertised maximum years of experience found in a job posting. Not all postings advertise maximum years of experience, when using this filter only postings with a maximum years of experience will be included in your results.
filter.max_years_experience_lower_bound
  • Lower bound for maximum years of experience.
  • This is an optional attribute.
  • Lower bound for the maximum years of experience required by a job posting (years are inclusive).
    Example: 4
    Minimum 0
filter.max_years_experience_upper_bound
  • Upper bound for maximum years of experience.
  • This is an optional attribute.
  • Upper bound for the maximum years of experience required by a job posting (years are inclusive).
    Example: 6
    Minimum 0
filter.min_edulevels
  • Filter by minimum education level ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["2"]
filter.min_edulevels_name
  • Filter by minimum education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Bachelor's degree"]
filter.min_salary
  • Filter by minimum advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the minimum advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.min_salary_lower_bound
  • Lower bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 55000
    Minimum 0
filter.min_salary_upper_bound
  • Upper bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 80000
    Minimum 0
filter.min_years_experience
  • Filter on the minimum years of experience requested in a posting.
  • This is an optional attribute.
  • This filter operates on the advertised minimum years of experience found in a job posting. Not all postings advertise minimum years of experience, when using this filter only postings with a minimum years of experience will be included in your results.
filter.min_years_experience_lower_bound
  • Lower bound for minimum years of experience.
  • This is an optional attribute.
  • Lower bound for the minimum years of experience required by a job posting (years are inclusive).
    Example: 1
    Minimum 0
filter.min_years_experience_upper_bound
  • Upper bound for minimum years of experience.
  • This is an optional attribute.
  • Upper bound for the minimum years of experience required by a job posting (years are inclusive).
    Example: 3
    Minimum 0
filter.nuts1
  • Filter by standard level 1 NUTS codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["UKF"]
filter.nuts1_name
  • Filter by standard level 1 NUTS names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["East Midlands"]
filter.nuts3
  • Filter by standard level 3 NUTS codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["UKF14"]
filter.nuts3_name
  • Filter by standard level 3 NUTS names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Nottingham"]
filter.posting_duration
  • Filter postings by how long they were active.
  • This is an optional attribute.
  • This filter operates on the number of days a posting has been active. This filter differs from the 'posting_duration' metric in that it will take into account currently active posting durations, where the metric only calculates duration of expired postings.
filter.posting_duration_lower_bound
  • Lower bound for posting duration.
  • This is an optional attribute.
  • Lower bound for the number of days a posting has been active for (days are inclusive).
    Example: 0
    Minimum 0
filter.posting_duration_upper_bound
  • Upper bound for posting duration.
  • This is an optional attribute.
  • Upper bound for the number of days a posting has been active for (days are inclusive).
    Example: 30
    Minimum 0
filter.remote_type
  • Filter by remote type ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["1"]
filter.remote_type_name
  • Filter by remote type names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Remote"]
filter.laa_country
  • Filter by LAA country.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["US"]
filter.laa_country_name
  • Filter by LAA country names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["United States"]
filter.laa_admin_area_1
  • Filter by LAA administrative area 1.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["US06"]
filter.laa_admin_area_1_name
  • Filter by LAA administrative area 1 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["California"]
filter.laa_admin_area_2
  • Filter by LAA administrative area 2.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["US06A"]
filter.laa_admin_area_2_name
  • Filter by LAA administrative area 2 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Los Angeles County"]
filter.laa_metro
  • Filter by LAA metro.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["US06AM"]
filter.laa_metro_name
  • Filter by LAA metro names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Los Angeles-Long Beach-Anaheim, CA Metro Area"]
filter.salary
  • Filter by average advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the average advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.salary_lower_bound
  • Lower bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example: 60000
    Minimum 0
filter.salary_upper_bound
  • Upper bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example: 70000
    Minimum 0
filter.skill_categories
  • Filter by skill category ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["1"]
filter.skill_categories_name
  • Filter by skill category names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Administration"]
filter.skill_subcategories
  • Filter by skill subcategory ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["103"]
filter.skill_subcategories_name
  • Filter by skill subcategory names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["General Administrative and Clerical Tasks"]
filter.skills

  • Filter by skill codes (any skill type).

  • This is an optional attribute.

  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.

    Example: ["KS7G2FY662ZPN6H4DZND"]

filter.skills_name
  • Filter by skill names (any skill type).
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["SQL (Programming Language)"]
filter.soc1
  • Filter by Lightcast 1-digit UK SOC codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering
Example: ["3"]
filter.soc1_name
  • Filter by Lightcast UK SOC1 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Associate Professional and Technical Occupations"]
filter.soc2
  • Filter by Lightcast 2-digit UK SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["35"]
filter.soc2_name
  • Filter by Lightcast UK SOC2 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Business and Public Service Associate Professionals"]
filter.soc3
  • Filter by Lightcast 3-digit UK SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["354"]
filter.soc3_name
  • Filter by Lightcast UK SOC3 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Sales, Marketing and Related Associate Professionals"]
filter.soc4
  • Filter by Lightcast 4-digit UK SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["3545"]
filter.soc4_name
  • Filter by Lightcast UK SOC4 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Sales accounts and business development managers"]
filter.sources
  • Filter by job posting source websites.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["monster.co.uk"]
filter.title_name
  • Filter by job title names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
Example: ["Web Developer"]
filter.ttwa
  • Filter by travel to work area ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["E30000234"]
filter.ttwa_name
  • Filter by travel to work area names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["London"]
filter.when
  • Filter postings by time.
  • Job posting timeframe filter, can be the string active (except for the timeseries endpoints) to match all currently active postings, or a more granular timeframe when object detailed below.
filter.when_type
  • Choose which date on a posting to filter by.
  • This is an optional attribute.
  • Determines how posting dates are evaluated.
  • posted - Match postings that were posted in your date range.
  • active - Match postings that were active within your date range.
  • expired - Match postings that expired in your date range.
  • Must be one of these values: "posted", "active", "expired"
    Default: "active"\
filter.when_end
  • Filter to postings before this date (inclusive).
  • The end of a date range, an ISO-8061 year-month or year-month-day date format.
    Example: "2019-06"
filter.when_start
  • Filter to postings after this date (inclusive).
  • The start of a date range, an ISO-8061 year-month or year-month-day date format.
    Example: "2018-06"
rank
  • Choose how to rank your results.
rank.by
  • What metric to use to rank the ranking facet.
  • This is an optional attribute.
  • Some metrics may be approximations for performance reasons.
  • Must be one of these values: "unique_postings", "duplicate_postings", "total_postings", "posting_intensity", "unique_companies", "significance", "average_salary"
    Default: "unique_postings"
rank.limit
  • Limit the number of ranked items returned.
  • This is an optional attribute.
  • Unlimited rankings (passing a limit of 0) are not valid for job titles, cities, companies, skills, and certifications facets. Additional maximum limits: Nested rankings: 100
  • Skills or certifications timeseries ranking when requesting a unique_companies metric: 100
    Minimum 0
    Maximum: 1000
    Default: 10
rank.extra_metrics
  • Request additional metrics for each ranked group returned.
  • This is an optional attribute.
  • In addition to 'by' metric, calculate these metrics for each ranked group. The median_posting_duration metric only applies to closed job postings. Some metrics may be approximations for performance reasons. The median_years_of_experience_required metric is the median experience required, based on job postings that include both a minimum and maximum requirement.
    Default: ["unique_postings"]
  • Array Items:
  • This is an optional attribute.
  • Must be one of these values: "unique_postings", "duplicate_postings", "total_postings", "posting_intensity", "unique_companies", "median_posting_duration", "min_salary", "median_salary", "max_salary", "average_salary", "median_years_of_experience_required"
rank.min_unique_postings
  • Filter ranked items by number of unique postings for the item.
  • This is an optional attribute.
  • Require ranked items to have at least this many unique postings matching the filter. Default: 3 when ranking by significance
    Minimum 1
    Default: 1
rank.include
  • Filter ranked items to only those provided in this field.
  • This is an optional attribute.
  • This field does not affect totals matched by the request query, it only filters the items returned in the ranking.
rank.exclude
  • Filter ranked items to only those not provided in this field.
  • This is an optional attribute.
  • This field does not affect totals matched by the request query, it only filters the items returned in the ranking.
distribution
  • Data distributions by percentiles or fixed interval.
distribution.type
  • Choose your distribution type.
  • Must be one of these values: "histogram", "percentile"
distribution.options
  • Select distribution settings.
  • keys is required for percentile, interval is required for histogram.
distribution.options_keys
  • Distribution percentiles.
  • This is an optional attribute.
  • Only valid for percentile type distribution.
distribution.options_interval
  • Distribution interval.
  • This is an optional attribute.
  • Only valid for histogram type distribution.
    Minimum 1
distribution.options_domain
  • Select minimum and maximum values for the data range.
  • This is an optional attribute.
  • Only valid for histogram type distribution.
distribution.options_domain_min
  • Enforced minimum value of the distribution
    Minimum 0
distribution.options_domain_max
  • Enforced maximum value of the distribution
    Minimum 1
distribution.metrics
  • Request additional metrics.
  • This is an optional attribute.
  • Some metrics may be approximations for performance reasons. The median_years_of_experience_required metric is the median experience required, based on job postings that include both a minimum and maximum requirement.
    Default: ["unique_postings"]
  • Array Items:
  • This is an optional attribute.
  • Must be one of these values: "unique_postings", "duplicate_postings", "total_postings", "posting_intensity", "unique_companies", "median_posting_duration", "min_salary", "median_salary", "max_salary", "average_salary", "median_years_of_experience_required"

Updated about 2 hours ago

Did this page help you?

Updated about 2 hours ago

Did this page help you?