Get Reports

Returns a list reports from the system. Can be filtered by the positionId, reportId, or candidateId. Will only return reports that are completed.

GET /reports

cURL

cURL

curl --request GET \
  --url https://api.alex.com/v1/api/reports \
  --header 'X-API-Key: <api-key>'

200

[
  {
    "reportId": "reportId",
    "candidateId": "candidateId",
    "positionId": "positonId",
    "externalJobId": "12345",
    "overallScore": 85,
    "overallFeedback": "The candidate performed well overall.",
    "questionSummary": [
      {
        "question": "What is your favorite color?",
        "summary": "The candidate's favorite color is blue."
      }
    ],
    "tags": [
      {
        "name": "Work Authorization",
        "value": "Yes",
        "evidence": "The candidate confirmed they are authorized to work in the United States"
      }
    ],
    "skills": [
      {
        "name": "Communication",
        "score": 85,
        "feedback": "The candidate communicated clearly and effectively."
      }
    ],
    "resumeFit": {
      "score": 85,
      "currentRole": "Senior Registered Nurse",
      "experienceSummary": "Six years of acute care nursing.",
      "explanation": {
        "breakdown": [
          {
            "category": "Clinical experience",
            "score": 90,
            "evidence": "Six years in an acute care setting.",
            "gapAnalysis": "No significant gaps identified.",
            "transferableSkills": "Triage under load."
          }
        ],
        "keyFitPoints": [
          "Direct ICU experience"
        ],
        "areasForDiscussion": [
          "Night shift availability"
        ]
      }
    },
    "timeCompleted": 1620000000,
    "videoURL": "https://example.com/video.mp4",
    "pdfURL": "https://example.com/report.pdf"
  }
]

At least one query parameter is required.

Authorizations

X-API-Key · string · header · required

Query Parameters

reportId · string

The id of the report to filter by. If this is provided, all other filters will be ignored.

positionId · string

The id of the position to filter by

candidateId · string

The id of the candidate to filter by

Response

200

application/json

Reports response

reportId · string

The unique identifier of the report

Example:

"reportId"

candidateId · string

The unique identifier of the candidate

Example:

"candidateId"

positionId · string

The unique identifier of the position

Example:

"positonId"

externalJobId · string | null

The ID of the position's job in the connected ATS, or null if there is no linked ATS record

Example:

"12345"

overallScore · number

The overall score of the candidate

Example:

85

overallFeedback · string

Feedback on the candidate's overall performance

Example:

"The candidate performed well overall."

questionSummary · object[]

List of dictionaries, each containing the question and a summary of the candidate's answer

Show child attributes

tags · object[]

A list of dictionaries, each containing the tag name, value, and evidence

Show child attributes

skills · object[]

A list of dictionaries, each containing the skill and the candidate's score and feedback

Show child attributes

resumeFit · object | null

The resume fit analysis for this candidate and position, or null if no analysis was run

Show child attributes

timeCompleted · number

The UNIX Epoch time (in seconds) of when the interview was completed

Example:

1620000000

videoURL · string

The public URL for an mp4 video recording of this interview, or an empty string if there is no recording

Example:

"https://example.com/video.mp4"

pdfURL · string

The public URL of the PDF report

Example:

"https://example.com/report.pdf"