API Documentation
Taxonomy
Employees
Job Families
Jobs
Peer Groups
Vacancies
Courses
Skill Clusters
External Companies
Skills
Organisational Structure
Custom Properties
Matchmaking
Matching Configuration
Export
Reports
Version
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/employees/metrics/adoption_metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
{
"query_id": "query-id",
"filters": [
{
"filter": "attribute",
"attribute_name": "organisational_unit",
"operator": "eq",
"attribute_value": "abc-123"
}
]
}
]
}
'{
"results": [
{
"query_id": "query-123-abc",
"metrics": {
"domains": [
{
"domain_name": "IT",
"external_id": "abdcde-domain",
"skill_clusters": [
{
"external_id": "abdcde-cluster",
"skill_cluster_name": "Software Engineering",
"skills": [
{
"skill_id": "abcde-skill-1",
"skill_name": "Automated Testing",
"unique_employee_count": 10
}
],
"sum_employee_skill_count": 10,
"unique_employee_count": 10,
"unique_skill_count": 1
}
],
"sum_employee_skill_count": 10,
"unique_employee_count": 10,
"unique_skill_count": 1
}
],
"skills_outside_taxonomy": {
"skills": [
{
"skill_id": "abcde-skill-2",
"skill_name": "Software Debugging",
"unique_employee_count": 5
}
],
"sum_employee_skill_count": 5,
"unique_employee_count": 5,
"unique_skill_count": 1
},
"sum_employee_skill_count": 15,
"unique_employee_count": 15,
"unique_skill_count": 2,
"total_employee_skill_count": 15
}
}
]
}Get Employee adoption metrics
Get adoption metrics across a collection of Employee objects stored in the system, aggregated over their Skills and your Taxonomy.
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/employees/metrics/adoption_metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
{
"query_id": "query-id",
"filters": [
{
"filter": "attribute",
"attribute_name": "organisational_unit",
"operator": "eq",
"attribute_value": "abc-123"
}
]
}
]
}
'{
"results": [
{
"query_id": "query-123-abc",
"metrics": {
"domains": [
{
"domain_name": "IT",
"external_id": "abdcde-domain",
"skill_clusters": [
{
"external_id": "abdcde-cluster",
"skill_cluster_name": "Software Engineering",
"skills": [
{
"skill_id": "abcde-skill-1",
"skill_name": "Automated Testing",
"unique_employee_count": 10
}
],
"sum_employee_skill_count": 10,
"unique_employee_count": 10,
"unique_skill_count": 1
}
],
"sum_employee_skill_count": 10,
"unique_employee_count": 10,
"unique_skill_count": 1
}
],
"skills_outside_taxonomy": {
"skills": [
{
"skill_id": "abcde-skill-2",
"skill_name": "Software Debugging",
"unique_employee_count": 5
}
],
"sum_employee_skill_count": 5,
"unique_employee_count": 5,
"unique_skill_count": 1
},
"sum_employee_skill_count": 15,
"unique_employee_count": 15,
"unique_skill_count": 2,
"total_employee_skill_count": 15
}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The external vendor vocabulary you want to use for the returned metrics. This will only work for vendors that are activated on your tenant.
workday, sap_attribute_library "workday"
Body
List of adoption metric queries. Each query corresponds with adoption metrics aggregated across the requested collection of objects.
Show child attributes
Show child attributes
A unique ID linked to the adoption metric query.
"query-id"
Filters to be applied on the entities for which adoption metrics need to be aggregated. If left empty, the adoption metrics are aggregated across all entities stored in the system.
1- attribute_equal
- attribute_is_empty
Show child attributes
Show child attributes
Filter on all entities for which attribute attribute_name is equal to attribute_value. Possible values for attribute_name are stated below.
attribute "attribute"
Name of the attribute on which the filter is applied.
organisational_unit The type of operator to apply on the attribute attribute_name.
eq Value of the attribute attribute_name
"abc-123"
Response
OK
- 3-level Taxonomy
- 4-level Taxonomy
- No Taxonomy
Response structure for Organisational Unit Metrics. Metrics are expressed in the structure of your Taxonomy. When a Skill is not represented in the Taxonomy, it will be included in the "Skills outside of the Taxonomy" Domain.
A list of metrics related to each Organisational Unit.
Show child attributes
Show child attributes
The unique ID of the query.
Aggregated statistics for the Organisational Unit, broken down by Domains, Skill Clusters, and Skills.
Show child attributes
Show child attributes
A list of all Domains within the Organisational Unit.
Show child attributes
Show child attributes
The name of the Domain.
The external ID of the Domain.
A list of Skill Clusters within the Domain.
Show child attributes
Show child attributes
The external ID of the Skill Cluster.
The name of the Skill Cluster.
A list of Skills within the Skill Cluster.
Show child attributes
Show child attributes
The name of the Skill.
1"Machine Learning"
The universally unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this id can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.
1 - 100"a3903505-eb84-42dc-a79f-5e7b1fe897b7"
Number of distinct Employees possessing this Skill.
Total number of times Employees possess Skills within this Taxonomy level, counting each Skill even if an Employee has more than one.
Number of distinct Employees with at least one Skill in this Taxonomy level.
The total number of unique Skills of all Employees within this Taxonomy level.
Total number of times Employees possess Skills within this Taxonomy level, counting each Skill even if an Employee has more than one.
Number of distinct Employees with at least one Skill in this Taxonomy level.
The total number of unique Skills of all Employees within this Taxonomy level.
A list of Skills not present in the Taxonomy.
Show child attributes
Show child attributes
A list of skills that are not present in the Taxonomy.
Show child attributes
Show child attributes
The name of the Skill.
1"Machine Learning"
The universally unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this id can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.
1 - 100"a3903505-eb84-42dc-a79f-5e7b1fe897b7"
Number of distinct Employees possessing this Skill.
Total number of times Employees possess Skills within this Taxonomy level, counting each Skill even if an Employee has more than one.
Number of distinct Employees with at least one Skill in this Taxonomy level.
The total number of unique Skills of all Employees within this Taxonomy level.
Total number of times Employees possess Skills within this Taxonomy level, counting each Skill even if an Employee has more than one.
Number of distinct Employees with at least one Skill in this Taxonomy level.
The total number of unique Skills of all Employees within this Taxonomy level.
Total number of times Employees possess Skills within this Taxonomy level, counting each Skill even if an Employee has more than one.
Was this page helpful?