TestGorilla's API documentation

https://app.testgorilla.com/testtaker/publicinvitation/<PUBLIC_LINK_UUID>

For example, for an assessment with public_uuid="d799f88f-...-ad9e04435b92"  the public link would be:

https://app.testgorilla.com/testtaker/publicinvitation/d799f88f-...-ad9e04435b92 

4.2 Activating/deactivating a public link

curl 'https://app.testgorilla.com/api/assessments/public_links/<PUBLIC_LINK_ID>/' \ 
-X 'PUT' \ 
-H 'authorization: Token <YOUR TOKEN GOES HERE>' \ 
-H 'content-type: application/json' \ 
--data-binary '{"active" : false, "label":"General public link", "assessment":<ASSESSMENT_ID>}'

4.3 Inviting a candidate using their email address

curl 'https://app.testgorilla.com/api/assessments/<ASSESSMENT_ID>/invite_candidate/' \
-H 'content-type: application/json' \
-H 'Authorization: Token <YOUR TOKEN GOES HERE>' \
--data-binary '{"email":"john@example.com","first_name":"John","last_name":"Smith"}'

{
  "id":8000,
  "assessment":32,
  "email":"john@example.com",
  "first_name":"John",
  "last_name":"Smith",
  "invitation_uuid":"d1bb9864-0515-4543-9bac-f26af0b13895",
  "created":"2020-09-29T07:55:14.517886+00:00",
  "testtaker_id":4276,
  "status":"invited"
}

curl --location --request POST 'https://app.testgorilla.com/api/assessments/candidature/675368/send-invitation/' \
--header 'authorization: Token <YOUR TOKEN GOES HERE>' \
--header 'content-type: application/json' \
--data-raw '{}'

When using POST https://app.testgorilla.com/api/assessments/candidature/675368/send-invitation/ you can include the no_email parameter. If you send this parameter as true, the invitation email won't be sent.

  "results": [
    {
      avg_score: 76,
      created: "2020-04-18T09:16:33.975663+02:00",
      email: "john@example.com",
      full_name: "John Smith",
      id: 8000,
      invitation_uuid: "edb70e44-271d-4e6a-8533-901fdc95f230",
      is_hired: false,
      personality_algorithm: 'big_5',
      personality: "3-3-1-1-1_30-32-28-19-28",
      rating: null
      review: null
      stage: "HIR"
      status: "completed"
      testtaker_id: 4276,
    }, 
    {...}
  ]
}

 {
    "count": 20,
    "next": "https://app.testgorilla.com/api/assessments/candidates/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 321321,
            "full_name": "John, Doe",
            "email": "johndoe@email.com",
            "tests": [
                # Grouped list of tests
            ],
            "assessments": [
                # List of assessments taken by the Customer
                { "assessment_name": "An assessment" }
                ...
            ],
            "assessments_count": 1,
            "last_activity": "2021-02-23T00:12:40.717337+01:00",
            ...
        },
        ...
    ]
}

6. Test Results

6.1. Retrieving assessment results

A detailed version of each candidate’s test results for a specific assessment can be pulled using the API endpoint GET https://app.testgorilla.com/api/assessments/results/?candidature__assessment=<ASSESSMENT_ID>&candidature__test_taker=<TESTAKER_ID>

Query Parameters

• Section 1: The calibrated score, from 1 (Very Low) to 5 (Very High) separated by “-“

• Section 2: The original (unprocessed) score, in decimal values separated by “-“

Those five values correspond to the five factors in the following order:

1. Extroversion

2. Agreeableness

3. Conscientiousness

4. Emotional stability

5. Openness to experience

You can pick the section you are interested in, splitting the string by '_' (underscore). You can then get each individual result splitting the string again by '-' (dash).

Example : 2-1-1-2-1_30.0-29.0-33.0-26.0-31.0

• Section 1 : 2-1-1-2-1

• Section 2: 30.0-29.0-33.0-26.0-31.0

Within TestGorilla, the result looks as follows:

Enneagram

The Enneagram personality test results are those where the algorithm attribute equals enneagram. For this test, the score_display attribute has one of the following values:

The only value that does not have a description is No results and will result in an HTTP 404 response if looked up using the description endpoint.

DISC

The DISC personality test results are those where the algorithm attribute equals disc. For this test, the score_display attribute has one of the following values:

16 types

The 16 types personality test results are those where the algorithm attribute equals 16_types. For this test, the score_display attribute represents the dominant letters across 4 scales: E-I, S-N, T-F, and J-P. As a result, the possible values are:

6.2.4 Personality Description Endpoint

If you need a mechanism to dynamically pull a personality report, you can use the personality description endpoint GET https://app.testgorilla.com/api/tests/personality/<ALGORITHM>/<SCORE> specifying the algorithm and the corresponding value to get detailed information about what each specific score means.

Request

curl --location --request GET 'https://app.testgorilla.com/api/tests/personality/<ALGORITHM>/<SCORE>' \
--header 'Authorization: Token <YOUR TOKEN GOES HERE>'

Response

{
    "personality":"..."
}

For example, if you want to get the details for INTJ - The Intellectual for 16 Types tests, you must send the algorithm 16_types and the score value uses INTJ in the URL.

curl --location --request GET 'https://app.testgorilla.com/api/tests/personality/16_types/INTJ' \
--header 'Authorization: Token <YOUR TOKEN GOES HERE>' 

{

    "personality":"<h2>INTJ – The Intellectual</h2>\n \n <h3>Description</h3>\n 
                   <p>INTJs are systematic, analytical, and intuitive thinkers. This 
                   is a rare combination, making it one of the least common personality
                   ... "
}