API Documentation

API Versioning

Taxonomy

Domains
Subdomains
Skill Clusters
Skills
Taxonomy operations

Employees

CRUD
Skill Profile
Metrics
Search
Skill Events
Interactions
Suggestions

Job Families

CRUD
Skill Profile
Job Family Profile Data

Jobs

CRUD
Skill Profile
Job Profile Data
Metrics

Vacancies

CRUD
Skill Profile
Metrics
Search

Courses

CRUD
Skill Profile
Metrics

Skill Clusters

CRUD
Skill Profile
Metrics

External Companies

CRUD
Search

Skills

Skill Search
Skill Gaps
Skill Lookup

Organisational Structure

Organisational Units

Custom Properties

Definitions
Properties

Matchmaking

Vacancy Matching
Course Recommendations
External Company Matching
Job Matching
Job Family Matching
Match Feedback

Matching Configuration

Filters

Export

Employees
Job Architecture
Courses
Employees Assigned Position
Taxonomy
Organisational Structure

Reports

General Reports
Employee Reports
Vacancy Reports
Job Reports
Data Maturity Scan

Version

Version

Get the internal talent mobility report.

This report generates a zip file containing the following files:

dim_employee.csv : A list of all Employees in the system, containing their external IDs and Custom Properties provided in employee_columns.
fact_employee_property.csv : A list of Custom Property mappings containing external IDs of the Employee, Custom Property name and Custom Property value for all the Custom Properties provided in employee_properties.
dim_vacancy.csv : A list of all Vacancies in the system, containing external IDs and Custom Properties provided in vacancy_columns.
fact_vacancy_property.csv : A list of Custom Property mappings containing external IDs of the Vacancy, Custom Property name and Custom Property value for all Custom Properties provided in vacancy_properties.
fact_vacancy_skill.csv : Contains a list of all Vacancy external ID-Skill pairs.
fact_match_skill.csv : Contains the match score for every Skill for all Employee-Vacancy pairs.
dim_skill.csv : A list of all Skills referred to in the files above containing the external IDs, the name and the description.
fact_match.csv : Contains the match score of all Employee-Vacancy pairs.

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/internal_talent_mobility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_employees_per_vacancy": 50,
  "employee_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "employee_properties": [
    {
      "property_name": "fact_property_name"
    }
  ],
  "vacancy_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "vacancy_properties": [
    {
      "property_name": "fact_property_name"
    }
  ]
}'

This response does not have an example.

Authorizations

Authorization

string

header

required

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

Query Parameters

force_recalculate

boolean

default:

false

Reports are always stored for a certain time, and if this endpoint is called again within that time, the stored report is returned without recalculating. If force_recalculate is set to true, the report is recalculated and the stored report is overwritten.

Body

application/json

Filters for the Skill inventory report.

max_employees_per_vacancy

number

required

The max number of Employees that will be matched for each Vacancy.

Required range: 1 < x < 100

employee_columns

object[]

The Custom Property columns that will be included in the dim_employee.csv file.

employee_properties

object[]

The Custom Properties that will be included in the fact_employee_properties.csv file.

vacancy_columns

object[]

The Custom Property columns that will be included in the dim_vacancy.csv file.

vacancy_properties

object[]

The Custom Properties that will be included in the fact_vacancy_property.csv file.

Response

200

application/zip

OK.

The response is of type file.

Was this page helpful?

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/internal_talent_mobility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_employees_per_vacancy": 50,
  "employee_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "employee_properties": [
    {
      "property_name": "fact_property_name"
    }
  ],
  "vacancy_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "vacancy_properties": [
    {
      "property_name": "fact_property_name"
    }
  ]
}'

This response does not have an example.