List of available services

General Services

`/token`

Returns a valid token

Parameters

email (required) : email of a valid JMI account
password (required) : password of a valid JMI account

Response example

"auth":{
  "token": "ABCDEFGHIJKLMNOPQRSTUVXYWZ"
}

`/scopes`

Returns the list of available scopes for the current user

Parameters

token (required) : authentication token

Response example

"scopes":[
  {
	"key": "58",
	"label": "CV-library.co.uk"
  },{
	"key": "72",
	"label": "Fish4.co.uk"
  },...
]

`/missingAdvertisers`

Returns the list of missing advertisers along with the number of market offers and number of sites of each company. echo element is added to the response.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user, scope cannot be of type country
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
size : the size of the result set
offset : the offset of the result set
arbitrary set of filters : details about filters

Response example

"total":
	{
		"offers": 50982,
		"companies": 1352
	},
"companies":[
	{
		"value": "Tesco"
		"market": 2548,
		"sites": 22,
		"comSize": "10000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Tesco",
		"google-url": "https://www.google.co.uk/search?q=Tesco",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Tesco"
	},{
		"value": "Pizza Hut"
		"market": 2176,
		"sites": 27,
		"comSize": "1000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Pizza+Hut",
		"google-url": "https://www.google.co.uk/search?q=Pizza+Hut",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Pizza+Hut",
		"you-last-12-months": 1
	},...
]

`/report`

Returns the list of elements corresponding to the primaryField fullfilling the given query. Each element contains the number of offers for market, the number of offers for you and the share. Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user.
primaryField : default is category
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
size : the size of the result set. Max. value is 1000
offset : the offset of the result set
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"primaryField" : "company",
"jobType" : "Permanent",
"sortTable" : "market",
"offset" : 150,
"size" : 50

Response example

"companies":[
	{
		"value": "Capita Plc",
		"you": 509,
		"market": 781,
		"share": 0.652,
		"comSize": "10000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Capita+Plc",
		"google-url": "https://www.google.co.uk/search?q=Capita+Plc",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Capita+Plc"
	},{
		"value": "Reeson Education",
		"you": 396,		
		"market": 765,
		"share": 0.518,
		"comSize": "1000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Reeson+Education",
		"google-url": "https://www.google.co.uk/search?q=Reeson+Education",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Reeson+Education"
		},...
],
"total":
	{
		"you": 118402
		"market": 597156,
		"share": 0.198,
	},	
"echo":{
	"version" : "1.1",	
	"scope": "58",
	"period": "-1",
	"jobType" : "Permanent",
	"size": 50,
	"offset": 150,
	"sortTable": "market",
	"primaryField": "company"
}

`/shareVariation`

Returns the list of elements corresponding to the primaryField fullfilling the given query and changes compared to the previous period. Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user.
primaryField : default is category
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
sortTable : default is you in the given period
shareVariationType : default is gains
size : the size of the result set. Max. value is 1000
offset : the offset of the result set
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"primaryField" : "company",
"period" : "-3",
"sortTable" : "previousPeriod.market",
"shareVariationType" : "losses",
"offset" : 150,
"size" : 50

Response example

"companies":[
	{
		"value": "Logical Personnel Solutions Limited",
		"shareVariation": -0.009,
		"comSize": "10000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Logical+Personnel+Solutions+Limited",
		"google-url": "https://www.google.co.uk/search?q=Logical+Personnel+Solutions+Limited",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Logical+Personnel+Solutions+Limited",
		"period": {
			"you": 115,
			"market": 393,
			"share": 0.293
		},
		"previousPeriod": {
			"you": 150,
			"market": 508,
			"share": 0.295
		}
	},
	{
		"value": "Anglo Technical Recruitment Limited",
		"shareVariation": -0.296,
		"comSize": "1000",
		"jmi-url": "https://www.jobmarketinsights.com/jmi-area/DetailRedirect?primaryField=company&company=Logical+Personnel+Solutions+Limited",
		"google-url": "https://www.google.co.uk/search?q=Anglo+Technical+Recruitment+Limited",
		"linkedin-url": "https://www.linkedin.com/search/results/companies?keywords=Anglo+Technical+Recruitment+Limited",
		"period": {
			"you": 170,
			"market": 530,
			"share": 0.321
		},
		"previousPeriod": {
			"you": 231,
			"market": 507,
			"share": 0.456
		}
	},...
],
"echo":{
	"version" : "1.1",
	"scope": "58",
	"period": "-3",
	"size": 50,
	"offset": 150,
	"sortTable": "previousPeriod.market",
	"shareVariationType": "losses",
	"primaryField": "company"
}

`/sites`

Returns the list of sites with the number of offers, companies, shared offers and shared companies in the given period
Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user
sortTable : possible values are offers (default),companies,shared-offers and shared-companies
size : the number of sites shown
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"period" : "Q2_2017"
"location" : ":London",

Response example

"sites":[
	{
		"key": "533",
		"label": "jobserve.com",
		"offers": 31205,
	},
	{
		"key": "1697",
		"label": "jobsite.co.uk",
		"offers": 28544,
	},...
],
"echo":{
	"version" : "1.1",
	"scope": "58",
	"period": "Q2_2017",
	"location": "GB|ENG|GLA|London"
}

`/marketOverview`

Returns the list of sites with the relative number of offers, shared offers, companies and shared companies.
Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user.
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
size : the size of the result set. Max. value is 100
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"period" : "Q2_2017"
"category" : "IT",
"location" : ":London",
"size": 5

Response example

"sites":[
	{
		"key": "533",
		"label": "jobserve.com",
		"offers": 31205,
		"shared-offers": 20556,
		"companies": 3718,
		"shared-companies": 1285
	},
	{
		"key": "1697",
		"label": "jobsite.co.uk",
		"offers": 28544,
		"shared-offers": 13211,
		"companies": 2179,
		"shared-companies": 819
	},...
],
"total": 
	{
		"offers": 549216,
		"companies": 18511
	},
"echo":{
	"version" : "1.1",
	"scope": "58",
	"period": "Q2_2017",
	"category" : "IT",
	"location": "GB|ENG|GLA|London",
	"size": 5	
}

`/offers`

Returns the list of offers matching the given filters.
Each element contains title, description, howToApply, location, company, salary, jobType and category of a unique offer along with a list of postings (duplicate offers) with id, date,titleOriginal,salaryOriginal site and url. The field howToApply won't be shown if missing. The response includes the total number of unique offers matching the given filters.
Response includes an echo element.

When the number of offers is big and doesn't fit in one response it's possible to repeat the same request changing the offset to move the starting point in the result set.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user.
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
size : the size of the result set. Max. value is 100. Default is 100.
offset : the offset of the result set
strictPeriod : if true postings with a date outside the selected period are not displayed. Default is false.
displayCrmId : if true and using version 1.1 will display crmId inside company if it's informed for current scope.
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"scope": "58",
"period": "-1",
"category" : "IT",
"site" : "28",
"size" : 20

Response example

"offers":[
	{
		"title": "Software Test Engineer",
		"company": {
			"value" : "The One Group Ltd",
			"comType":{
				"key" : "1",
				"label" : "COMPANY"
			}	
		},
		"howToApply": "send your CV to hr@company.com",
		"jobType": "Permanent",
		"numberOfVacancies": 1,
		"description": "Software Test Engineer - Cambridge - £35,000 - £45,000 + Benefits...",
		"location":{
			"label": "Cambridge",
			"key": "GB|ENG|C3|Cambridge"
		},
		"category":{
			"key": "IT",
			"label": "IT - Telecomm"
		},
		"salary":{
			"key": "20000",
			"label": "£20,000 - £40,000"
		},			
		"postings":[
			{
				"id" : 123,
				"date": "2017-07-18",
				"titleOriginal": "Software Test Engineer - Permanent",
				"salaryOriginal": "£22k - £23k pa + Bonus",
				"site":{
					"key": "1697",
					"label": "jobsite.co.uk"
				},
				"url": "http://www.jobsite.co.uk/job/958661545?&utm_medium..."
			},{
				"id" : 456,
				"date": "2017-07-18",
				"titleOriginal": "Software Test Engineer",
				"salaryOriginal": "£35k annual",
				"site":{
					"key": "28",
					"label": "CV-library.co.uk"
				},
				"url": "http://www.cv-library.co.uk/job/206222..."
			},{...
		]
	},{...
],
"total":{
	"offers": 10319
},	
"echo":{
	"version" : "1.1",
	"scope": "58",
	"period": "-1",
	"category" : "IT",
	"site" : "28",
	"size": 20,
	"offset" : 0
}

Here a brief definition of the elements in the response:

Offer

Field name	Always present/optional	Description
description	always present	Full text of the offer
title	always present	Title of the offer
postings	always present	List of posting, at least one (decribed below)
howToApply	optional	Method to apply to the offer (like "email to", "call the number", etc.)
company	optional	Company name normalized
location	optional	Location normalized: clear name, coded geoname
category	optional	JobMarketInsights classification: clear name, coded name
salary	optional	Salary range
jobType	optional	Work schedule and/or Contract
numberOfVacancies	optional	Number of vacancies of the current offer

The postings field (above) is a list of:

Posting

Field name	Always present/optional	Description
id	always present	Unique posting ID
date	always present	Publication date
url	always present	Link to the original offer
titleOriginal	always present	Original title of the posting
site	always present	Publication job board, clear name, numeric reference
salaryOriginal	optional	Original salary of the posting

`/count`

Returns the total offers and total companies matching the given filters.
Response includes the total number of unique offers and companies matching the given filters. Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user.
period : default is last month
if the period is custom is possible to set a date range with these dates:
- customDateFrom : begin of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
- customDateTo : end of the period, in the format YYYY-MM-DD (i.e. "2021-03-08")
arbitrary set of filters : details about filters

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"scope": "58",
"period": "-1"

Response example

"offers":{
	"you": 94791,
	"market": 1069226,
	"share": 0.089
},
"companies":{
	"you": 3112,
	"market": 50613,
	"share": 0.061
},		
"echo":{
	"version" : "1.1",
	"scope": "58",
	"period": "-1"
}

`/normalize`

Returns the normalized values for the given input fields company and/or location.
Response includes an echo element.

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user, scope cannot be of type country
location : will return the normalized key - label for the given text
company : will return the normalized value for the given text, since version 1.1 company field is enriched with the comType field.
crmId : will return the normalized value for the company with the given CRM ID

Request example

"token" : "ABCDEFGHIJKLMNOPQRSTUVXYWZ",
"scope" : "58",
"location" : "Birmingham, west midlands B44 8JH",
"company" : "Adecco Ltd."

Response example

"normalized":{
	"location":{
		"label": "Birmingham",
		"key": "GB|ENG|A7|Birmingham"
	},
	"company": {
		"value": "Adecco"
		"comType":{
			"label" : "RECRUITMENT_AGENCY",
			"key" : "2"
		}
	}
}
"echo":{
	"version" : "1.1",
	"scope": "58",
	"company": "Adecco Ltd.",
	"location" : "Birmingham, west midlands B44 8JH"
}

`/timeline`

Returns the offer couters per month, matching the given filters.
Each element contains the number of offers for market and the number of offers for you. Response includes an echo element.

Response example

"timeline":[
    {
        "market": 863866,
        "date": "2020-01-15",
        "you": 198409
    },
    {
        "market": 764520,
        "date": "2020-02-15",
        "you": 166708
    },
    {
        "market": 651701,
        "date": "2020-03-15",
        "you": 136089
    },
    {
        "market": 327431,
        "date": "2020-04-15",
        "you": 56368
    },...

Metadata Services

`/periods`

Returns the list of available values for the period field

Parameters

token (required) : authentication token

Response example

"periods":[
	{
		"key": "2018-03",
		"label": "Mar 2018",
		"from": "2018-03-01",
		"to": "2018-04-01"
		
	},
	{
		"key": "2018-02",
		"label": "Feb 2018",
		"from": "2018-02-01",
		"to": "2018-03-01"
	},
  },...
]

`/salaries`

Returns the list of available values for the salary field.

Parameters

token (required) : authentication token

Optional parameters

scope : default is the first available scope for this user

Response example

"salaries":[
	{
		"key": "0",
		"label": "up to £20,000"
	},{
		"key": "20000",
		"label": "£20,000 - £40,000"
	},{
		"key": "40000",
		"label": "£40,000 - £60,000"
	},...
]

`/categories`

Returns the list of available values for the category field

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user

Response example

"categories":[
	{
		"key": "ED",
		"label": "Education"
	},{
		"key": "EN",
		"label": "Engineering"
	},...
]

`/jobTypes`

Returns the list of available values for the jobType field

Parameters

token (required) : authentication token
scope : default is the first available scope for the current user

Response example

"jobTypes":[
	{
		"value": "Permanent"
	},{
		"value": "Temporary"
	},{
		"value": "Part-Time"
	},{
		"value": "Contract"
	},{
		"value": "Apprenticeship"
	}
]

`/comSizes`

Returns the list of available values for the comSize field

Parameters

token (required) : authentication token

Response example

"comSizes":[
	{
		"key": "0",
		"label": "0-49 postings"
	},{
		"key": "50",
		"label": "50-249 postings"
	},...
]

`/comTypes`

Returns the list of available values (key - label) for the comType field

Parameters

token (required) : authentication token

Response example

"comTypes":[
	{
		"key": "1",
		"label": "COMPANY",
	},{
		"key": "2",
		"label": "RECRUITMENT_AGENCY"
	}
]

-----------------------------------

`/locationLevels`

Returns the list of available values (key - label) for the locationLevel field

Parameters

token (required) : authentication token

Response example

"locationLevels":[
	{
		"key": "loc",
		"label": "Location",
	},{
		"key": "sub",
		"label": "Sub Administrative Area"
	},...
]