Parameters and Fields

List of parameters and fields:

General Parameters

scope

Is a key - label parameter that define which are the offers of your scope. Counters and other references to your scope will be labelled as you in the result sets.
Scope can be set using its key. i.e:

{"scope" : "43"}

Service /scopes returns the list of available scopes for the current user.
The use of a scope unavailable for your account will return an unauthorized message.

period

Is a key - label parameter representing the period of time. period object also contains the boundary dates from and to
Can be set using its key. i.e:

{"period" : "-1W"}

Service /periods returns the list of available periods.

customDateFrom and customDateTo

If the period is set to custom is possible to set a date range with these parameters.
The parameter customDateFrom sets the begin of the period, the parameter customDateTo the end of the period.
For both of them the format is YYYY-MM-DD

{
	"period" : "custom",
	"customDateFrom" : "2020-02-17",
	"customDateTo" : "2020-03-05"
}

With the custom dates it's possible to set a period going back 24 months in time. The maximum lenght of the period is 12 months.
When this limit is exceeded the period will be set to the last month.

sortTable

Represents the column by which the query is sorted.
Accept only you (default) and market as valid values. i.e:

{"sortTable" : "market"}

In case of /shareVariation service, it is necesary the use of period or previousPeriod prefix. i.e:

{"sortTable" : "previousPeriod.market"}

sortOrder

Represents the order of the sorting.
Accept only desc (default) or asc as valid values. i.e:

{"sortOrder" : "asc"}

offset

Represents the offset of the result set.
Accept integer values from 0 (default) to 75,000 (this limit may vary depending on your account). i.e:

{"offset" : 50}

Per example if you use size: 100, first page will be:

{"size":100, "offset": 0}

And second page:

{"size":100, "offset": 100}

size

Represents the size of the result set.
Accept positive integer values. Default is 25, the maximum possible value is 100.

{"size" : 50}

primaryField

Represents the field of the facet in /report service.
Valid values are category,location,company,title or salary. i.e:

{"primaryField" : "company"}

locationLevel

When using the /report service and the primaryField is equals the location this extra field can be used.
The location will be grouped at the level selected with this field.
Valid values are cou, adm, sub or loc.

{"locationLevel" : "cou"}

Service /locationLevels returns the list of available values.

shareVariationType

Represents if the share variation field is positive or negative in /shareVariation service.
Valid values are gains and losses. i.e:

{"shareVariationType" : "gains"}

liveJobs

When set to true shows results based on all Live jobs during the time period selected, regardless of when they were published. The number of jobs we show within your results will likely increase with this setting.

When not present or set to false shows results based on all jobs published during the selected time period.

Valid values are true and false (default). i.e:

{"liveJobs" : "true"}

Fields/Filters

The following filters can be used in most of the services to filter the result set.
Add the chosen set of filters to the body of the request (or alternately to the query-string of the URI).

In this example offers (both you and market columns, see Custom Market to apply filters only to the market columns) are filtered by category "Information Technology" and location "Northern Ireland".

{
	"category" : "IT",
	"location" : "GB|NIR"
}

Filter names are also used to label the fields returned in the result set.

category

Is a key - label field representing the category of the offer.
Can be used as a query filter using its key. i.e:

{"category" : "IT"}

Accepts multiple values. i.e:

{"category" : "IT^EN"}

Can be set as primaryField. i.e:

{"primaryField" : "category"}

Service /categories returns the list of available categories for the country associated to this scope.

salary

Is a key - label field representing the salary range of the offer.
Can be used as a query filter using its key. i.e:

{"salary" : "20000"}

or can be declared as primaryField i.e:

{"primaryField" : "salary"}

Service /salaries returns the list of available salaries for the country associated to this scope.

company

Is a value field representing the company of the offer.
Companies in the result set contains extra attributes such as google-url, linkedin-url and crm_id (if any).
Can be used as a query filter and accepts the operators !, ^, * and quoted text.

Examples:

Company contains the word studio:

{"company" : "studio"}

Company contains the word architect and engineer:

{"company" : "architect engineer"}

Company contains the word architect or engineer:

{"company" : "architect^engineer"}

Company does not contain the word design:

{"company" : "!design"}

Company does not contain the words university and college:

{"company" : "!university !college"}

Company contains the words studio but does not contain the word design:

{"company" : "studio !design"}

Company contains a word that begins with the term intern

{"company" : "intern*"}

Company contains a word that ends with the term ational

{"company" : "*ational"}

Company is exactly Adecco:

{"company" : "\"Adecco\""}

Company is exactly Adecco or Hays:

{"company" : "\"Adecco\"^\"Hays\""}

Company begins exactly with the term University:

{"company" : "\"University*\""}

Company ends exactly with the term ways:

{"company" : "\"*ways\""}

Terms are always case-insensitive, quoted terms are always case-sensitive.

To apply company filter only to the market column (Custom Market) in the /report service nest this parameter in the mkt JSON Object:
(for more details see Custom Market)

{
  "mkt" : {
    "company" : "\"Adecco\""
  }
}

Can be set as primaryField. i.e:

{"primaryField" : "company"}

Since version 1.1 some services like /offers and /normalize return a structured company object with additional informations such as the company comType. i.e:

"company" :{
	"value": "Adecco",
	"comType":{
		"label" : "RECRUITMENT_AGENCY",
		"key" : "2"
	}
}

title

Is a value field representing the title of the offer.
Can be used as a query filter and accepts the operators !, ^, * and quoted text.

Examples:

Title contains the word assistant:

{"title" : "assistant"}

Title contains the word account and executive:

{"title" : "account executive"}

Title contains the word advisor or consultant:

{"title" : "advisor^consultant"}

Title does not contain the word junior:

{"title" : "!junior"}

Title does not contain the words senior and experience:

{"title" : "!experience !senior"}

Title contains the words driver but does not contain the word truck:

{"title" : "driver !truck"}

Title contains a word that begins with the term technic

{"title" : "technic*"}

Title contains a word that ends with the term ology

{"title" : "*ology"}

Title is exactly Graduate Engineer:

{"title" : "\"Graduate Engineer\""}

Title is exactly Graduate Engineer or Supervisor:

{"title" : "\"Graduate Engineer\"^\"Supervisor\""}

Title begins exactly with the term Devel:

{"title" : "\"Devel*\""}

Title ends exactly with the term onist:

{"title" : "\"*onist\""}

Terms are always case-insensitive, quoted terms are always case-sensitive.

Can be set as primaryField. i.e:

{"primaryField" : "title"}

description

Is a value field representing the description of the offer.
Can be used as a query filter and accepts the operators !, ^, * and quoted text.

Examples:

Description contains the word assistant:

{"description" : "assistant"}

Description contains the word account and executive:

{"description" : "account executive"}

Description contains the word advisor or consultant:

{"description" : "advisor^consultant"}

Description does not contain the word junior:

{"description" : "!junior"}

Description does not contain the words senior and experience:

{"description" : "!experience !senior"}

Description contains the words driver but does not contain the word truck:

{"description" : "driver !truck"}

Description contains a word that begins with the term technic

{"description" : "technic*"}

Description contains a word that ends with the term ology

{"description" : "*ology"}

location

Is a key - label field representing the location of the offer.
Can be used as a query filter using its key. i.e:

{"location" : "GB|ENG|I2|Manchester"}

Accepts multiple values. i.e:

{"location" : "GB|ENG|I2|Manchester^GB|ENG|A7|Birmingham"}

To get the key for an arbitrary text use the /normalize service.

Location key follow this structure : {cou}|{adm}|{sub}|{loc}

where

  • {cou} is the international country code (two letters)
  • {adm} is the administrative area of the 1st level (State, Region, Department,..)
  • {sub} is the sub-administrative area or administrative area of the 2nd level (Province, County, Municipality,..)
  • {loc} is the city, town or village

site

Is a key - label field representing the site in which the offer has been published.
An offer can have multiple sites.
Can be used as a query filter using its key. i.e:

{"site" : "28"}

Accepts multiple values. i.e:

{"site" : "2^28"}

To apply site filter only to the market column (Custom Market) in the /report service nest this parameter in the mkt JSON Object:
(for more details and special values for site classifications see Custom Market)

The result set of this request will include all the sites classified as "generalist". { "mkt" : { "site" : "G" } }

Service /sites returns the facet of sites fullfilling the given query.

jobType

Is a value field representing the job type of the offer.
Can be used as a query filter using its value. i.e:

{"jobType" : "Permanent"}

Accepts multiple values. i.e:

{"jobType" : "Permanent^Temporary"}

Service /jobTypes returns the list of available job types for the country associated to this scope.

comSize

Is a key - label field representing the size of the company of the offer.
Can be used as a query filter using its key. i.e:

{"comSize" : "50"}

Accepts multiple values. i.e:

{"comSize" : "50^250"}

Service /comSizes returns the list of available company sizes.

comType

Is a key - label field representing the type of the company of the offer.
It has two possible values:

{
	"key" : "1",
	"label" : "COMPANY"
}

and

{
	"key" : "2",
	"label" : "RECRUITMENT_AGENCY"
}

Can be used as a query filter using its key. i.e:

{"comType" : "1"}

Values with a leading negative sign mean exclusion, i.e:

{"comType" : "-2"}

will exclude all the offers with a company of type RECRUITMENT_AGENCY.

Service /comTypes returns the list of available company types.

comJobBoard

Is a value field representing the posting behaviour of the offer in the last 12 months.
Valid values are -1 (Offer posted in Multiple Sites) and 1 (Offer posted in a Single Site).
Can be used as a query filter using its value. i.e:

{"comJobBoard" : "-1"}

singlePost

Is a value field representing if the offer has been published only once.
Valid values are 1 (Offer published only once) and -1 (Offer published more than once). In both cases offers with no company will be excluded from the results.
Can be used as a query filter using its value. i.e:

{"singlePost" : "1"}

hotVacancies

This parameter sets the shown offers to be posted multiple times with periods of at least 2 weeks in between. If true, the start of the period cannot be less than the start of last month, if the period has a date has a date before last month, the period will automatically change to -1 (default). Default value is false. Valid values are: true and false. i.e:

{"hotVacancies" : "true"}

companyYouHad

Acceptance Criteria: true: Companies that have posted within the past 12 months that are not active on sitename for the time period selected false: Companies posting within the market during the past 12 months and not on sitename

Default value is false. Valid values are: true and false. i.e:

{"companyYouHad" : "true"}