Assessments

Assessments are the key component in measuring each user's personality. A unique assessment is created for each user, allowing you to easily collect and filter specific data post-assessment. While the content of a deck in an assessment is fixed, you have free range to present and style it as you want or using our style guide components.

Create

This method allows you to create a new assessment. A new assessment is required for each of your users. The 'id' in the response will be your unique identifier to continue this assessment at a later time, view the result, or do any matching.

Resource Information

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

Parameters

deck_id
required
This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.
Example values: core, career-deck, super-hero

Example Request

POST
Authorization: Basic {your_secret_key}:x
https://api.traitify.com/v1/assessments
{
  "deck_id": "career-deck"
}

Example Response

201 Created
{
    "id": "acff3436-2801-4b13-90b3-25eeeceffba9",
    "deck_id": "career-deck",
    "completed_at": null,
    "created_at": 1394655449646
}