Defining a query
The ComplexQueryRequest object
ComplexQueryRequest
metric
enum<string>
required
Allowed values:
demandsalary
date_range
required
One of
type
enum<string>
required
Allowed value:
absolute
start
string <date>
required
Example:
2023-07-19
Match pattern:
^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9])$
end
string <date>
required
Example:
2024-07-22
Match pattern:
^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9])$
filter
optional
One of
type
enum<string>
required
Allowed value:
rule
dimension
enum<string>
required
Allowed values:
apprenticeship_levelapprenticeship_typecategorycompanycontract_hourscontract_typeeducation_levelindustrylocationoccupationqualificationsalaryseniorityskillskill_tagworkplace_modelyears_of_experience
operator
enum<string>
required
Allowed values:
eqneqgteltegtltanynone
target
required
taxonomy_id
integer
optional
breakdown
object (Breakdown)
optional
dimension
enum<string>
required
Allowed values:
apprenticeship_levelapprenticeship_typecategorycompanycontract_hourscontract_typeeducation_levelindustrylocationoccupationqualificationsalaryseniorityskillskill_tagworkplace_modelyears_of_experience
taxonomy_id
integer
optional
location_type_id
integer
optional
The ComplexQueryResponse object
ComplexQueryResponse
metric
enum<string>
required
Allowed values:
demandsalary
key_metrics
object (MetricValue)
required
metric_value
required
breakdown_dimension
enum<string>
required
Allowed values:
apprenticeship_levelapprenticeship_typecategorycompanycontract_hourscontract_typeeducation_levelindustrylocationoccupationqualificationsalaryseniorityskillskill_tagworkplace_modelyears_of_experience
breakdown
array[object (BreakdownResult) {2}]
required
metric_value
required
breakdown_value
object (BreakdownValue)
required
raw
array[object (RawData) {3}]
required
date
string <date-time>
required
metric_value
required
breakdown_value
object (BreakdownValue)
required