Get Employee Quality Matrix - TechWolf Developer Portal

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

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/data_maturity_scan/employee_quality_matrix \
  --header 'Authorization: Bearer <token>'

{
  "report_name": "employee_quality_matrix",
  "report_data": {
    "entity_count": 100,
    "data_quality_matrix": [
      {
        "source": "JIRA",
        "event_type": "ticket",
        "source_type": "employee-specific",
        "source_coverage": 0.8,
        "empty_profile": 0.05,
        "source_quality": 0.85,
        "total_skill_volume": 45,
        "unique_skill_volume": 24,
        "source_differentation": 0.68
      }
    ]
  },
  "last_update": "2020-09-01T11:45:49Z"
}

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.

Response

200

application/json

The Data Quality Matrix per data source and Skill Event type averaged over all Employees.

report_name

string

Name of the report.

report_data

object

report_data.entity_count

number

The number of Employees uploaded to the tenant.

report_data.data_quality_matrix

object[]

Data Quality Matrix metrics per data source and Skill Event type averaged over all Employees.

report_data.data_quality_matrix.source

string

The source system of the Skill Event. This is used to keep track of where Skill Events originate from.

report_data.data_quality_matrix.event_type

enum<string>

Type of the Skill Event. Learn more about the Skill Event Types at <u>How it works</u>.

Available options:

working_history,

education_history,

resume_document,

learning,

feedback,

goal,

project,

ticket,

certificate,

skill_notes

report_data.data_quality_matrix.source_type

enum<string>

The type of information this source adds:

‘job-specific' indicates that the Skills extracted from this source are generic across Employees having the same Job.
‘employee-specific’ indicates that this source contributes to the overall granularity of the Employees’ Skill Profiles.

Available options:

job-specific,

employee-specific

report_data.data_quality_matrix.source_coverage

number

The percentage of Employees that have at least one SkillEvent of this data source and type, that is considered coherent (i.e. it makes probabilistic sense for the Skills in the Event's Skill Profile to appear together).

report_data.data_quality_matrix.empty_profile

number

The percentage of Skill Events of a data source and type for which no Skills have been found.

report_data.data_quality_matrix.source_quality

number

The percentage of Skill Events of a data source and type that are considered coherent (i.e. it makes probabilistic sense for the Skills in the Event's Skill Profile to appear together). For example, it might indicate poor quality when the Skills ‘Recruiting’ and ‘Processing Invoices’ are tagged to the same learning event.

report_data.data_quality_matrix.total_skill_volume

number

The average number of total Skills per Employee that could be inferred from the data source and type.

report_data.data_quality_matrix.unique_skill_volume

number

The average number of unique Skills per Employee that could inferred from the data source and type.

report_data.data_quality_matrix.source_differentation

number

Linked to the average number of Skills unique to the data source. If the model finds all Skills from the source in other sources, it does not add new Skills. Instead, it increases the confidence of Skills extracted from other sources. High differentiation means that almost all Skills from the source are new skills that are not found in the other sources.

last_update

string

Was this page helpful?

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/data_maturity_scan/employee_quality_matrix \
  --header 'Authorization: Bearer <token>'

{
  "report_name": "employee_quality_matrix",
  "report_data": {
    "entity_count": 100,
    "data_quality_matrix": [
      {
        "source": "JIRA",
        "event_type": "ticket",
        "source_type": "employee-specific",
        "source_coverage": 0.8,
        "empty_profile": 0.05,
        "source_quality": 0.85,
        "total_skill_volume": 45,
        "unique_skill_volume": 24,
        "source_differentation": 0.68
      }
    ]
  },
  "last_update": "2020-09-01T11:45:49Z"
}