Status Page
API Reference

Requst Parameters - Nested Rankings

Nested Rankings Request Parameters

Detailed reference for all supported Job Postings - Global Nested Rankings 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.
Example ["ET6850661D6AE5FA86"]
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.anz_sco_1
  • Filter by ANZSCO 1 IDs.
  • This is an optional attribute.
Example ["8"]
filter.anz_sco_1_name
  • Filter by ANZSCO 1 names.
  • This is an optional attribute.
Example ["Labourers"]
filter.anz_sco_2
  • Filter by ANZSCO 2 IDs.
  • This is an optional attribute.
Example ["89"]
filter.anz_sco_2_name
  • Filter by ANZSCO 2 names.
  • This is an optional attribute.
Example ["Other Labourers"]
filter.anz_sco_3
  • Filter by ANZSCO 3 IDs.
  • This is an optional attribute.
Example ["891"]
filter.anz_sco_3_name
  • Filter by ANZSCO 3 names.
  • This is an optional attribute.
Example ["Freight Handlers and Shelf Fillers"]
filter.anz_sco_4
  • Filter by ANZSCO 4 IDs.
  • This is an optional attribute.
Example ["8911"]
filter.anz_sco_4_name
  • Filter by ANZSCO 4 names.
  • This is an optional attribute.
Example ["Freight and Furniture Handlers"]
filter.anz_sco_5
  • Filter by ANZSCO 5 IDs.
  • This is an optional attribute.
Example ["891111"]
filter.anz_sco_5_name
  • Filter by ANZSCO 5 names.
  • This is an optional attribute.
Example ["Freight Handler (Rail or Road)"]
filter.anz_sic_1
  • Filter by ANZSIC 1 IDs.
  • This is an optional attribute.
Example ["A"]
filter.anz_sic_1_name
  • Filter by ANZSIC 1 names.
  • This is an optional attribute.
Example ["Agriculture, Forestry and Fishing"]
filter.anz_sic_2
  • Filter by ANZSIC 2 IDs.
  • This is an optional attribute.
Example ["01"]
filter.anz_sic_2_name
  • Filter by ANZSIC 2 names.
  • This is an optional attribute.
Example ["Agriculture"]
filter.anz_sic_3
  • Filter by ANZSIC 3 IDs.
  • This is an optional attribute.
Example ["011"]
filter.anz_sic_3_name
  • Filter by ANZSIC 3 names.
  • This is an optional attribute.
Example ["Nursery and Floriculture Production"]
filter.anz_sic_4
  • Filter by ANZSIC 4 IDs.
  • This is an optional attribute.
Example ["0111"]
filter.anz_sic_4_name
  • Filter by ANZSIC 4 names.
  • This is an optional attribute.
Example ["Nursery Production (Under Cover)"]
filter.company
  • Filter by normalized company codes.
  • This is an optional attribute.
    Example ["NC9d0d7c83-619e-46eb-ae10-7bd2876a6857"]
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 normalized company names.
  • This is an optional attribute.
    Example ["Microsoft Corporation"]
filter.company_name_v2
  • Filter by normalized company names (v2).
  • This is an optional attribute.
  • During Phase 1, values are dual-tagged with company_name.
    Example ["Otti & Partner"]
filter.company_v2
  • Filter by normalized company codes (v2).
  • This is an optional attribute.
  • During Phase 1, values are dual-tagged with company.
    Example ["99485189"]
filter.contract_type
  • Filter by normalized contract type codes.
  • This is an optional attribute.
    Example ["2"]
filter.contract_type_name
  • Filter by normalized contract type names.
  • This is an optional attribute.
    Example ["Permanent contract"]
filter.edulevels
  • Filter by normalized education level codes.
  • This is an optional attribute.
    Example [0]
filter.edulevels_name
  • Filter by normalized education level names.
  • This is an optional attribute.
    Example ["High school or GED"]
filter.employment_type
  • Filter by employment type (Full/Part time) codes.
  • This is an optional attribute.
    Example [1]
filter.employment_type_name
  • Filter by employment type (Full/Part time) names.
  • This is an optional attribute.
    Example ["Full-time (> 32 hours)"]
filter.isced
  • Filter by education level id.
  • This is an optional attribute.
    Example ["1"]
filter.isced_name
  • Filter by education level name.
  • This is an optional attribute.
    Example ["Early childhood education"]
filter.isco_1
  • Beta (may change without warning).
  • Filter by ISCO 1 codes.
  • This is an optional attribute.
Example ["2"]
filter.isco_1_name
  • Beta (may change without warning).
  • Filter by ISCO 1 names.
  • This is an optional attribute.
Example ["Professionals"]
filter.isco_2
  • Beta (may change without warning).
  • Filter by ISCO 2 codes.
  • This is an optional attribute.
Example ["32"]
filter.isco_2_name
  • Beta (may change without warning).
  • Filter by ISCO 2 names.
  • This is an optional attribute.
Example ["Health Associate Professionals"]
filter.isco_3
  • Beta (may change without warning).
  • Filter by ISCO 3 codes.
  • This is an optional attribute.
Example ["242"]
filter.isco_3_name
  • Beta (may change without warning).
  • Filter by ISCO 3 names.
  • This is an optional attribute.
Example ["Administration Professionals"]
filter.isco_4
  • Beta (may change without warning).
  • Filter by ISCO 4 codes.
  • This is an optional attribute.
Example ["2423"]
filter.isco_4_name
  • Beta (may change without warning).
  • Filter by ISCO 4 names.
  • This is an optional attribute.
Example ["Personnel and Careers Professionals"]
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.laa_admin_area_1
  • Filter by Lightcast Administration Area 1 codes.
  • This is an optional attribute.
Example ["AT33"]
filter.laa_admin_area_1_name
  • Filter by Lightcast Administration Area 1 names.
  • This is an optional attribute.
Example ["Tyrol"]
filter.laa_admin_area_2
  • Filter by Lightcast Administration Area 2 codes.
  • This is an optional attribute.
Example ["AT112"]
filter.laa_admin_area_2_name
  • Filter by Lightcast Administration Area 2 names.
  • This is an optional attribute.
Example ["Nordburgenland"]
filter.laa_country
  • Filter by Lightcast Administration Area country codes.
  • This is an optional attribute.
Example ["CZ"]
filter.laa_country_name
  • Filter by Lightcast Administration Area country names.
  • This is an optional attribute.
Example ["Czechia"]
filter.laa_metro
  • Filter by Lightcast Administration Area metro codes.
  • This is an optional attribute.
Example ["AT003M"]
filter.laa_metro_name
  • Filter by Lightcast Administration Area metro names.
  • This is an optional attribute.
Example ["Linz Metropolitan Area"]
filter.lot_career_area
  • Filter by career area IDs.
  • This is an optional attribute.
    Example ["27"]
filter.lot_career_area_name
  • Filter by career area names.
  • This is an optional attribute.
    Example ["Marketing and Public Relations"]
filter.lot_occupation
  • Filter by occupation IDs.
  • This is an optional attribute.
    Example ["271210"]
filter.lot_occupation_group
  • Filter by occupation group IDs.
  • This is an optional attribute.
    Example ["2712"]
filter.lot_occupation_group_name
  • Filter by occupation group names.
  • This is an optional attribute.
    Example ["Marketing Specialists"]
filter.lot_occupation_name
  • Filter by occupation names.
  • This is an optional attribute.
    Example ["E-Commerce Analyst"]
filter.lot_specialized_occupation
  • Filter by specialized occupation IDs.
  • This is an optional attribute.
    Example ["27121011"]
filter.lot_specialized_occupation_name
  • Filter by specialized occupation names.
  • This is an optional attribute.
    Example ["E-Commerce Assistant"]
filter.max_edulevels
  • Filter by maximum education level IDs.
  • This is an optional attribute.
    Example ["3"]
filter.max_edulevels_name
  • Filter by maximum education level names.
  • This is an optional attribute.
    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.
  • The salary is represented in USD. See the currency taxonomy for information on converting to and from other currencies.
filter.max_salary_lower_bound
  • Lower bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example 55000
    Maximum: 0
filter.max_salary_upper_bound
  • Upper bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example 80000
    Maximum: 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
    Maximum: 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
    Maximum: 0
filter.min_edulevels
  • Filter by minimum education level IDs.
  • This is an optional attribute.
    Example ["2"]
filter.min_edulevels_name
  • Filter by minimum education level names.
  • This is an optional attribute.
    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.
  • The salary is represented in USD. See the currency taxonomy for information on converting to and from other currencies.
filter.min_salary_lower_bound
  • Lower bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example 55000
    Maximum: 0
filter.min_salary_upper_bound
  • Upper bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example 80000
    Maximum: 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
    Maximum: 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
    Maximum: 0
filter.nace_1
  • Beta (may change without warning).
  • Filter by NACE 1 codes.
  • This is an optional attribute.
Example ["Q"]
filter.nace_1_name
  • Beta (may change without warning).
  • Filter by NACE 1 names.
  • This is an optional attribute.
Example ["Human Health and Social Work Activities"]
filter.nace_2
  • Beta (may change without warning).
  • Filter by NACE 2 codes.
  • This is an optional attribute.
Example ["86"]
filter.nace_2_name
  • Beta (may change without warning).
  • Filter by NACE 2 names.
  • This is an optional attribute.
Example ["Human Health Activities"]
filter.naics2
  • Filter by normalized 2-digit company NAICS codes.
  • This is an optional attribute.
    Example ["31"]
filter.naics2_name
  • Filter by normalized 2-digit company NAICS names.
  • This is an optional attribute.
    Example ["Manufacturing"]
filter.naics3
  • Filter by normalized 3-digit company NAICS codes.
  • This is an optional attribute.
    Example ["334"]
filter.naics3_name
  • Filter by normalized 3-digit company NAICS names.
  • This is an optional attribute.
    Example ["Computer and Electronic Product Manufacturing"]
filter.naics4
  • Filter by normalized 4-digit company NAICS codes.
  • This is an optional attribute.
    Example ["3341"]
filter.naics4_name
  • Filter by normalized 4-digit company NAICS names.
  • This is an optional attribute.
    Example ["Computer and Peripheral Equipment Manufacturing"]
filter.naics5
  • Filter by normalized 5-digit company NAICS codes.
  • This is an optional attribute.
    Example ["33411"]
filter.naics5_name
  • Filter by normalized 5-digit company NAICS names.
  • This is an optional attribute.
    Example ["Computer and Peripheral Equipment Manufacturing"]
filter.naics6
  • Filter by normalized 6-digit company NAICS codes.
  • This is an optional attribute.
    Example ["334111"]
filter.naics6_name
  • Filter by normalized 6-digit company NAICS names.
  • This is an optional attribute.
    Example ["Electronic Computer Manufacturing"]
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
    Maximum: 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
    Maximum: 0
filter.remote_type
  • Filter by Remote Type.
  • This is an optional attribute.
Example ["0"]
filter.remote_type_name
  • Filter by Remote Type names.
  • This is an optional attribute.
Example ["Remote"]
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.
  • The salary is represented in USD. See the currency taxonomy for information on converting to and from other currencies.
filter.salary_lower_bound
  • Lower bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example 50000
    Maximum: 0
filter.salary_upper_bound
  • Upper bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example 200000
    Maximum: 0
filter.skill_categories
  • Filter by skill category IDs.
  • This is an optional attribute.
    Example ["1"]
filter.skill_categories_name
  • Filter by skill category names.
  • This is an optional attribute.
    Example ["Administration"]
filter.skill_subcategories
  • Filter by skill subcategory IDs.
  • This is an optional attribute.
    Example ["103"]
filter.skill_subcategories_name
  • Filter by skill subcategory names.
  • This is an optional attribute.
    Example ["General Administrative and Clerical Tasks"]
filter.skills
  • Filter by skill codes (any skill type).
  • This is an optional attribute.
    Example ["KS440W865GC4VRBW6LJP"]
filter.skills_name
  • Filter by skill names (any skill type).
  • This is an optional attribute.
    Example ["SQL (Programming Language)"]
filter.title_name
  • Filter by job title names.
  • This is an optional attribute.
Example ["Software Engineers"]
filter.when
  • Filter postings by time.
  • Job posting time frame filter, can be "active" (except for the timeseries endpoints) to match all currently active postings, or a more granular time frame 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"
filter.city
  • Filter by normalized city codes.
  • This is an optional attribute.
    Example ["0J/QsNC30LrQvtC70LDRgNC+LCBNZXRyb3BvbGl0YW4gQ2l0eSBPZiBSb21l"]
filter.city_name
  • Filter by normalized city names.
  • This is an optional attribute.
    Example ["Пазколаро, Metropolitan City Of Rome"]
filter.language
  • Filter by normalized language codes.
  • This is an optional attribute.
    Example ["en"]
filter.language_name
  • Filter by normalized language names.
  • This is an optional attribute.
    Example ["English"]
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"
    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 companies, titles, skills, and certifications facets. Additional maximum limits:
  • Nested rankings: 100
    Maximum: 0
    Maximum: 10000
    Default: 10
rank.extra_metrics
  • Request additional metrics for each ranked group returned.
  • This is an optional attribute.
  • In addition to the '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", "median_salary", "min_salary", "max_salary", "average_salary", "median_years_of_experience_required"
rank.min_unique_postings
  • Filter ranked items by the number of unique postings for each 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
    Maximum: 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.
nested_rank
  • Choose how to rank your results
nested_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"
    Default: "unique_postings"
nested_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 companies, titles, skills, and certifications facets. Additional maximum limits:
  • Nested rankings: 100
    Maximum: 0
    Maximum: 10000
    Default: 10
nested_rank.extra_metrics
  • Request additional metrics for each ranked group returned.
  • This is an optional attribute.
  • In addition to the '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", "median_salary", "min_salary", "max_salary", "average_salary", "median_years_of_experience_required"
nested_rank.min_unique_postings
  • Filter ranked items by the number of unique postings for each 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
    Maximum: 1
    Default: 1
nested_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.
nested_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.

Updated about 2 hours ago

Did this page help you?

Updated about 2 hours ago

Did this page help you?