Skip to main content
Get the employability metric using filters and weights
curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/metrics/employability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employee_filters": [
    {
      "filter": "max_geo_distance",
      "max_geo_distance": 50
    }
  ],
  "vacancy_filters": [
    {
      "filter": "max_geo_distance",
      "max_geo_distance": 50
    }
  ],
  "weights": [
    {
      "weight": "skills_match",
      "value": 1
    },
    {
      "weight": "desired_functions",
      "value": 0.03
    }
  ]
}
'
{
  "entity_type": "Employee",
  "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "metric_name": "configurable_employability",
  "metric_value": 0.8,
  "last_update": "2020-09-01T11:45:49Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.techwolf.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Body

application/json

Default structure for Employee data.

​
employee_filters
(max_geo_distance · object | custom_property · object | low_data_availability · object)[]
​
vacancy_filters
(max_geo_distance · object | custom_property · object | low_data_availability · object)[]
​
weights
(skills_match · object | desired_functions · object)[]
Example:
[
  { "weight": "skills_match", "value": 1 },
  {
    "weight": "desired_functions",
    "value": 0.03
  }
]

Response

OK

A measure indicating the degree to which this Employee can find other opportunities within your available Vacancies, reported as a number between 0 and 1.

​
entity_type
string
required
Example:

"Employee"

​
entity_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

​
metric_name
string
required
Example:

"configurable_employability"

​
metric_value
number<float>
required
Required range: 0 <= x <= 1
Example:

0.8

​
last_update
string<date-time>
required
Example:

"2020-09-01T11:45:49Z"