Access exam results and performance analytics for candidates.
The Results API provides access to exam scores, detailed performance metrics, and answer breakdowns. Use it to integrate assessment results into your hiring decision workflow.
/results| Name | Type | Required | Description |
|---|---|---|---|
| exam_id | string | Optional | Filter by exam ID |
| candidate_id | string | Optional | Filter by candidate ID |
| min_score | number | Optional | Filter by minimum score (0-100) |
| completed_after | string | Optional | Filter by completion date (ISO 8601) |
{
"data": [
{
"id": "result_ghi789",
"candidate_id": "cand_xyz789",
"exam_id": "exam_abc123",
"score": 87.5,
"percentile": 82,
"status": "passed",
"completed_at": "2024-02-12T09:15:00Z",
"duration_minutes": 58
}
],
"pagination": { "total": 89, "limit": 20, "has_more": true }
}/results/{result_id}{
"id": "result_ghi789",
"candidate_id": "cand_xyz789",
"exam_id": "exam_abc123",
"score": 87.5,
"percentile": 82,
"status": "passed",
"completed_at": "2024-02-12T09:15:00Z",
"duration_minutes": 58,
"breakdown": {
"by_category": [
{ "category": "Algorithms", "score": 90, "correct": 9, "total": 10 },
{ "category": "System Design", "score": 85, "correct": 17, "total": 20 }
],
"by_difficulty": [
{ "difficulty": "easy", "score": 95, "correct": 19, "total": 20 },
{ "difficulty": "medium", "score": 88, "correct": 22, "total": 25 },
{ "difficulty": "hard", "score": 60, "correct": 3, "total": 5 }
]
},
"strengths": ["Data Structures", "Algorithms", "Problem Solving"],
"weaknesses": ["System Design", "Database Optimization"]
}/results/{result_id}/answersResults may include sensitive performance data. Ensure proper access controls and audit logging when integrating this endpoint.
/results/{result_id}/export| Name | Type | Required | Description |
|---|---|---|---|
| format | string | Optional | Export format: pdf (default), csv |
| include_answers | boolean | Optional | Include answer details (default: false) |
Was this article helpful?