Get the Job Architecture benchmark report

Get your Job Architecture Benchmark containing the Jobs and how they compare to the ones in their peer groups. This report generates a zip file containing the following files:

dim_peer_group.csv: A list of all Jobs in the system, containing external IDs and the ID of the peer group.
fact_peer_group_property.csv: Currently unused.
dim_job.csv: A list of all Jobs present in the system, containing their external IDs, Job titles and Custom Properties provided in job_columns.
fact_job_property.csv: A list of Custom Property mappings containing external IDs of the Job, Custom Property name and Custom Property value for all Custom Properties provided in job_properties.
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_skill.csv: Contains the match score for every Skill for all peer group - Job pairs.
fact_match.csv: Contains the match score of all peer group - Job pairs.

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/job_architecture_benchmark \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "job_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "job_properties": [
    {
      "property_name": "fact_property_name"
    }
  ],
  "peer_group_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "peer_group_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

Options for the Job Architecture benchmark report.

The body is of type object.

Response

200

application/zip

OK.

The response is of type file.

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/job_architecture_benchmark \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "job_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "job_properties": [
    {
      "property_name": "fact_property_name"
    }
  ],
  "peer_group_columns": [
    {
      "column_name": "dim_column_name",
      "property_name": "dim_property_name"
    }
  ],
  "peer_group_properties": [
    {
      "property_name": "fact_property_name"
    }
  ]
}'

This response does not have an example.