GET
/
reports
curl --request GET \
  --url https://api.apriora.ai/v1/api/reports \
  --header 'X-API-Key: <api-key>'
[
  {
    "reportId": "reportId",
    "candidateId": "candidateId",
    "positionId": "positonId",
    "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."
      }
    ],
    "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"

​
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

A summary of the candidate's answer to a question

​
tags
object[]

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

The tag name, value, and evidence

​
skills
object[]

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

The candidate's score and feedback for a skill

​
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

Example:

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

​
pdfUrl
string

The public URL of the PDF report

Example:

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