Matching

Top Career Matches

This method uses Traitify's matching algorithm to match a user taking the career assessment with careers. This method will return the top matches for an assessment. You can get specific matches by passing in `careers_ids` or using the Specific Career Matches method. This can only be performed on assessments using the `career-deck` deck.

Resource Information

HTTP Method	GET
Resource URL	https://api.traitify.com/v1/assessments/{assessment_id}/matches/careers
Authentication Required?	Yes
Response Format	JSON

Query Parameters

number_of_matches optional	This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60. Example values: 1, 20, 4, 60
experience_levels optional	The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values. Example values: 1,2; 4,5; 3
career_ids optional	You can optionally pass in a list of ONET IDs of the careers that you want to match against. If you need to pass in more codes than a URL will allow (about 4,000 characters long), then you can refer to Specific Career Matches. Example values: 39-5094.00,25-1042.00

Example Request

GET
Authorization: Basic {your_public_key}:x
https://api.traitify.com/v1/assessments/{assessment_id}/matches/careers?number_of_matches=30,experience_levels=3,4

Example Response

200 OK

[
    {
        "career": {
            "id": "39-5094.00",
            "title": "Skincare Specialists",
            "description": "Provide skincare treatments to face and body to enhance an individual's appearance. Includes electrologists and laser hair removal specialists.",
            "majors": [
                {
                    "id": "12.0408",
                    "title": "Facial Treatment Specialist/Facialist.",
                    "description": "A program that prepares individuals to massage and treat the face, neck, and scalp with chemical and cosmetic preparations, and to function as licensed facial specialists in specialized and full service salons.  Includes instruction in facial surface anatomy; skin properties; skin decontamination and infection control; facial massage; facial makeup; facial wrapping; selection and application of creams, lotions, oils, and other chemicals and cosmetics; European and other facial techniques; client evaluation and care; applicable laws and regulations; and business practices.",
                    "group_id": "12"
                },
                ...
            ],
            "experience_level": {
                "id": 3,
                "name": "Medium Preparation Needed",
                "experience": "Previous work-related skill, knowledge, or experience is required for these occupations. For example, an electrician must have completed three or four years of apprenticeship or several years of vocational training, and often must have passed a licensing exam, in order to perform the job.",
                "education": "Most occupations in this zone require training in vocational schools, related on-the-job experience, or an associate's degree.",
                "job_training": "Employees in these occupations usually need one or two years of training involving both on-the-job experience and informal training with experienced workers. A recognized apprenticeship program may be associated with these occupations.",
                "examples": "These occupations usually involve using communication and organizational skills to coordinate, supervise, manage, or train others to accomplish goals. Examples include food service managers, electricians, agricultural technicians, legal secretaries, occupational therapy assistants, and medical assistants.",
                "svp_range": "(6.0 to < 7.0)"
            },
            "salary_projection": {
                "source": "Bureau Of Labor Statistics - May 2013",
                "total_employees": 33680,
                "hourly_rate_10_percentile": 8.4,
                "hourly_rate_25_percentile": 9.42,
                "hourly_rate_75_percentile": 18.83,
                "hourly_rate_90_percentile": 27.37,
                "hourly_rate_median": 13.92,
                "hourly_rate_mean": 15.86,
                "annual_salary_10_percentile": 17480,
                "annual_salary_25_percentile": 19590,
                "annual_salary_75_percentile": 39160,
                "annual_salary_90_percentile": 56930,
                "annual_salary_median": 28940,
                "annual_salary_mean": 32990
            },
            "employment_projection": {
                "source": "Bureau Of Labor Statistics - 2012",
                "annual_salary_median_2012": 28640,
                "total_employees_2012": 44400,
                "total_employees_2022": 62000,
                "new_openings_2022": 17700,
                "new_openings_and_replacement_2022": 21300,
                "percent_growth_2022": 39.8
            },
            "bright_outlooks": [
                "Rapid Growth"
            ]
        },
        "score": 76.1456929418168
    },
    ...
]

Specific Career Matches

This method will return results in the same format as Top Career Matches, but is intended for use when you have a list of O*NET Codes that you wish to get matches for rather than just getting the top matches.

Resource Information

HTTP Method	POST
Resource URL	https://api.traitify.com/v1/assessments/{assessment_id}/matches/careers
Authentication Required?	Yes
Response Format	JSON

Parameters

career_ids required	A list of O*NET Codes you want to have scored against the user's personality. Example values: 39-5094.00,25-1042.00

Example Request

POST
Authorization: Basic {your_public_key}:x
https://api.traitify.com/v1/assessments/{assessment_id}/matches/careers

[
  "39-5094.00",
  "19-3093.00",
  "39-3012.00",
  "33-9021.00"
]

Example Response

200 OK

[
    {
        "career": {
            "id": "39-5094.00",
            "title": "Skincare Specialists",
            "description": "Provide skincare treatments to face and body to enhance an individual's appearance. Includes electrologists and laser hair removal specialists.",
            "majors": [
                {
                    "id": "12.0408",
                    "title": "Facial Treatment Specialist/Facialist.",
                    "description": "A program that prepares individuals to massage and treat the face, neck, and scalp with chemical and cosmetic preparations, and to function as licensed facial specialists in specialized and full service salons.  Includes instruction in facial surface anatomy; skin properties; skin decontamination and infection control; facial massage; facial makeup; facial wrapping; selection and application of creams, lotions, oils, and other chemicals and cosmetics; European and other facial techniques; client evaluation and care; applicable laws and regulations; and business practices.",
                    "group_id": "12"
                },
                ...
            ],
            "experience_level": {
                "id": 3,
                "name": "Medium Preparation Needed",
                "experience": "Previous work-related skill, knowledge, or experience is required for these occupations. For example, an electrician must have completed three or four years of apprenticeship or several years of vocational training, and often must have passed a licensing exam, in order to perform the job.",
                "education": "Most occupations in this zone require training in vocational schools, related on-the-job experience, or an associate's degree.",
                "job_training": "Employees in these occupations usually need one or two years of training involving both on-the-job experience and informal training with experienced workers. A recognized apprenticeship program may be associated with these occupations.",
                "examples": "These occupations usually involve using communication and organizational skills to coordinate, supervise, manage, or train others to accomplish goals. Examples include food service managers, electricians, agricultural technicians, legal secretaries, occupational therapy assistants, and medical assistants.",
                "svp_range": "(6.0 to < 7.0)"
            },
            "salary_projection": {
                "source": "Bureau Of Labor Statistics - May 2013",
                "total_employees": 33680,
                "hourly_rate_10_percentile": 8.4,
                "hourly_rate_25_percentile": 9.42,
                "hourly_rate_75_percentile": 18.83,
                "hourly_rate_90_percentile": 27.37,
                "hourly_rate_median": 13.92,
                "hourly_rate_mean": 15.86,
                "annual_salary_10_percentile": 17480,
                "annual_salary_25_percentile": 19590,
                "annual_salary_75_percentile": 39160,
                "annual_salary_90_percentile": 56930,
                "annual_salary_median": 28940,
                "annual_salary_mean": 32990
            },
            "employment_projection": {
                "source": "Bureau Of Labor Statistics - 2012",
                "annual_salary_median_2012": 28640,
                "total_employees_2012": 44400,
                "total_employees_2022": 62000,
                "new_openings_2022": 17700,
                "new_openings_and_replacement_2022": 21300,
                "percent_growth_2022": 39.8
            },
            "bright_outlooks": [
                "Rapid Growth"
            ]
        },
        "score": 76.1456929418168
    },
    ...
]

continue to:
Versioning