Generate and access comprehensive assessment reports.
The Reports API provides access to aggregated analytics, team performance metrics, and custom report generation. Use it for hiring dashboards and performance tracking.
/reports| Name | Type | Required | Description |
|---|---|---|---|
| report_type | string | Required | Type: candidate_summary, exam_analytics, team_performance |
| date_from | string | Optional | Start date for report data (ISO 8601) |
| date_to | string | Optional | End date for report data (ISO 8601) |
| filters | object | Optional | Additional filters (exam_id, candidate_id, etc.) |
const report = await fetch('https://talentscreens.org/api/v1/reports', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
report_type: 'exam_analytics',
date_from: '2024-01-01',
date_to: '2024-02-01',
filters: { exam_id: 'exam_abc123' }
})
});/reports/{report_id}{
"id": "report_jkl012",
"status": "completed",
"report_type": "exam_analytics",
"created_at": "2024-02-12T10:00:00Z",
"completed_at": "2024-02-12T10:02:15Z",
"data": {
"total_attempts": 234,
"avg_score": 78.5,
"pass_rate": 0.72,
"avg_duration_minutes": 62,
"score_distribution": { "0-20": 5, "21-40": 12, "41-60": 48, "61-80": 97, "81-100": 72 }
},
"download_url": "https://storage.talentscreens.org/reports/..."
}/reportsExam analytics reports provide aggregated performance data across all candidates who took a specific exam, including score distributions, average completion time, and difficulty analysis.
Team performance reports aggregate results across your hiring team, showing metrics like invitations sent, completion rates, average scores by recruiter, and time-to-hire impact.
Large reports may take several minutes to generate. Poll the report status endpoint or use webhooks to receive completion notifications.
Was this article helpful?