ATS Analytics
To build reports and analyze hiring efficiency, use the following export flow.
1. Export jobs
Section titled “1. Export jobs”Fetch all jobs created or updated during the target period.
- Method:
POST /api/v1/jobs/search - Filters:
date_updated_fromanddate_updated_to
2. Export applicants
Section titled “2. Export applicants”Fetch all applicants added to the system.
- Method:
POST /api/v1/applicants/search - Filters:
date_created_fromanddate_created_to - Note: these may include resumes not yet linked to a job
3. Export candidates
Section titled “3. Export candidates”Fetch candidate records, meaning applicant-to-job assignments.
- Method:
POST /api/v1/candidates/search - Filters:
date_updated_fromanddate_updated_to - Action: store the returned
candidate.idvalues for the next step
4. Export actions
Section titled “4. Export actions”Fetch action history for those candidates.
- Method:
POST /api/v1/actions/search - Parameters: pass the
candidates_idscollected in the previous step - Result: you will see stage transitions, rejection reasons, and other activity events
5. Export interview feedbacks
Section titled “5. Export interview feedbacks”Fetch the scorecards interviewers filled in for a candidate. Both methods take one candidate at a time, so call them for the candidate.id values collected in step 3.
- Method:
GET /api/v1/candidates/{candidate_id}/feedbacks - Result: every feedback of the candidate with all of its questions and answers
- Requires:
feature ats_scorecards=trueand access to the candidate
Each element of answers describes one question and the answer to it:
question_title: the question as written in the scorecardquestion_type: open_answer, scale, select, employee_nps, goals, write_to_field, fileanswer_text: text of an open answercomment: interviewer comment, available on any question typeanswer_options: selected scale or select options, as textanswer_score: numeric value of the selected scale optionDecorative form elements (text) are not included - there is nothing to answer.
Feedbacks that nobody has filled in yet are returned too, with empty answer fields and a status other than completed.
6. Export feedback scores only
Section titled “6. Export feedback scores only”When you need the scores without the answer texts, use the aggregated method.
- Method:
GET /api/v1/candidates/{candidate_id}/feedbacks/overview - Result:
requested_count,completed_count,avg_scale_score,max_scale_score,avg_score_mark,score_marks - Requires:
feature ats_scorecards=trueand access to the candidate