Refcheck report
In order to implement report page like that (pic below), you need to send a request to the refcheck report endpoint.
Please read Working with questionnaires before.
The endpoint returns a list of report objects. Every report object contains the following fields
| field | description |
|---|---|
| question | A Question object. The set of fields depends on the question type. Read more about questions |
| answers | A list of answer objects. An answer object contains reference key that describes the reference (RefCheckReference model) the answer was provided by. The set of other fields depends on the question type, it's the same as you need to send to submit an answer. |
| summary | It contains a key inside. The name of the key depends on the question type. E.g. it contains an average value for "type": "stars5" question or highlighted answer for "type": "text" question. |
You can find and example of the report object for every question type below.
In order to get a quick overview of the refcheck, pass is_overview=1 query param to the refcheck report endpoint.
With is_overview, the endpoint returns a list of most important questions. Otherwise, the endpoint returns all questions.
Text field
The summary contains highlighted_answer inside with the most demonstrative answer text.
{
"question": {
"id": 1,
"title": "what is your name?1",
"type": "text"
},
"answers": [
{
"id": 57,
"question": 1,
"ref_check": 50,
"text": "My name is Peer 1",
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 58,
"question": 1,
"ref_check": 50,
"text": "My name is peer 2",
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
}
],
"summary": {
"highlighted_answer": "My name is Peer 1"
}
}
Select
The summary contains top_choices key which is a list of the following objects
| field | type | description |
|---|---|---|
| choice | object | contains id and title of the question option |
| count | int | represents how many times this option was selected |
| selected_by_candidate | bool | reflects if a candidate selected this option |
| references | list of objects | list of references who selected the option |
{
"question": {
"id": 2,
"title": "your skills1",
"type": "choice",
"choice_count_min": 2,
"choice_count_max": 4,
"choices": [
{
"id": 12,
"title": "go lang 1"
},
{
"id": 11,
"title": "django 1"
},
{
"id": 10,
"title": "python 1"
}
]
},
"answers": [
{
"id": 61,
"question": 2,
"ref_check": 50,
"choices": [
10,
12
],
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 62,
"question": 2,
"ref_check": 50,
"choices": [
12
],
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 62,
"question": 2,
"ref_check": 50,
"choices": [
12
],
"reference": null
}
],
"summary": {
"top_choices": [
{
"references": [
{
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
},
{
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
],
"count": 2,
"selected_by_candidate": true,
"choice": {
"id": 12,
"title": "go lang 1"
}
},
{
"references": [
{
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
],
"count": 1,
"selected_by_candidate": false,
"choice": {
"id": 10,
"title": "python 1"
}
}
]
}
}
5 stars rating
The summary contains avg_value key with the average value among all answers provided by references.
It also contains self_value key with the value provided by a candidate.
{
"question": {
"id": 7,
"title": "rate using 5 stars1",
"type": "stars5",
"choices": [
{
"value": 1,
"title": "Poor"
},
{
"value": 2,
"title": "Fair"
},
{
"value": 3,
"title": "Good"
},
{
"value": 4,
"title": "Very good"
},
{
"value": 5,
"title": "Excellent"
}
]
},
"answers": [
{
"id": 59,
"question": 7,
"ref_check": 50,
"value": 4,
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 60,
"question": 7,
"ref_check": 50,
"value": 3,
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 60,
"question": 7,
"ref_check": 50,
"value": 4,
"reference": null
}
],
"summary": {
"avg_value": 3.5,
"self_value": 4
}
}
Choose degree between two extremes
The summary contains avg_value key with the average value among all answers provided by references.
It also contains self_value key with the value provided by a candidate.
{
"question": {
"id": 8,
"title": "how reasonable is your workload1",
"type": "extremes",
"extreme_left": "very unreasonable1",
"extreme_right": "very reasonable",
"choices": [
{
"value": 0,
"title": "Much more"
},
{
"value": 1,
"title": "About the same"
},
{
"value": 2,
"title": "Much more"
}
]
},
"answers": [
{
"id": 69,
"question": 8,
"ref_check": 50,
"value": 2,
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 69,
"question": 8,
"ref_check": 50,
"value": 1,
"reference": null
}
],
"summary": {
"avg_value": 2.0,
"self_value": 1
}
}
Multi-question grid
The summary is not available now. Waiting for the report page UI design to implement the summary.
{
"question": {
"id": 9,
"title": "How would you rate on these attributes1",
"type": "grid",
"grid_questions": [
{
"id": 3,
"title": "handles stress well1"
},
{
"id": 2,
"title": "takes feedback well1"
},
{
"id": 1,
"title": "attention to detail1"
}
],
"choices": [
{
"value": 0,
"title": "Okay"
},
{
"value": 1,
"title": "Good"
},
{
"value": 2,
"title": "Really good"
},
{
"value": 3,
"title": "Great"
},
{
"value": 4,
"title": "Best"
},
{
"value": 5,
"title": "I don't know"
}
]
},
"answers": [
{
"id": 63,
"question": 9,
"ref_check": 50,
"value": 3,
"grid_question": 3,
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 64,
"question": 9,
"ref_check": 50,
"value": 4,
"grid_question": 2,
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 65,
"question": 9,
"ref_check": 50,
"value": 3,
"grid_question": 1,
"reference": {
"id": 4,
"position": "peer",
"email": "peer1@example.ccomm",
"first_name": "Peer 1",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 66,
"question": 9,
"ref_check": 50,
"value": 1,
"grid_question": 3,
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 67,
"question": 9,
"ref_check": 50,
"value": 2,
"grid_question": 2,
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 68,
"question": 9,
"ref_check": 50,
"value": 3,
"grid_question": 1,
"reference": {
"id": 5,
"position": "peer",
"email": "peer2@example.ccomm",
"first_name": "Peer 2",
"last_name": null,
"company": "google",
"start_work": null,
"end_work": null
}
},
{
"id": 68,
"question": 9,
"ref_check": 50,
"value": 4,
"grid_question": 1,
"reference": null
},
{
"id": 68,
"question": 9,
"ref_check": 50,
"value": 4,
"grid_question": 2,
"reference": null
},
{
"id": 68,
"question": 9,
"ref_check": 50,
"value": 4,
"grid_question": 3,
"reference": null
}
],
"summary": {
"questions": [
{
"grid_question": 1,
"order": 0,
"avg_value": 3,
"self_value": 4
},
{
"grid_question": 2,
"order": 1,
"avg_value": 3.33,
"self_value": 4
},
{
"grid_question": 3,
"order": 2,
"avg_value": 2,
"self_value": 4
}
]
}
}