Skip to main content
GET
/
v1
/
installs
/
{installSid}
/
reports
/
examSessionEvents
Session Events
curl --request GET \
  --url https://api.smarterproctoring.com/v1/installs/{installSid}/reports/examSessionEvents \
  --header 'token: <api-key>'
{
  "total": 123,
  "first": "<string>",
  "next": "<string>",
  "prev": "<string>",
  "last": "<string>",
  "count": 123,
  "offset": 123,
  "results": [
    {
      "sid": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "appointmentDate": "<string>",
      "sessionType": "<string>",
      "courseTitle": "<string>",
      "examType": "<string>",
      "examTitle": "<string>",
      "sessionStatus": "<string>",
      "eventSid": "<string>",
      "eventTime": "<string>",
      "title": "<string>",
      "subject": "<string>",
      "details": "<string>",
      "potentialDamage": "<string>",
      "directWitness": "<string>",
      "status": "<string>",
      "correctiveActionDetails": "<string>",
      "contactPerson": "<string>",
      "contactEmail": "<string>",
      "contactPhone": "<string>"
    }
  ]
}

Authorizations

​
token
string
header
required

Path Parameters

​
installSid
string
required

Install Sid

Pattern: ^AI[a-f0-9]{32}$

Query Parameters

​
courseTitle
string

Course title

​
examTitle
string

Exam title

​
studentFirstName
string

First Name of student

​
studentLastName
string

Last Name of student

​
instructorFirstName
string

First Name of Instructor

​
instructorLastName
string

Last Name of Instructor

​
eventTypeSid
string

Event Type Sid

Pattern: ^ET[a-f0-9]{32}$
​
sessionEventStatus
string

Event status

​
eventTimeRangeStart
string

Starting of event, must provide end date with it

Pattern: .*Z
Example:

"1970-01-01T00:00:00.000Z"

​
eventTimeRangeEnd
string

Exam Close date, must provide open date with it

Pattern: .*Z
Example:

"1970-01-01T00:00:00.000Z"

​
courseOfferingSid
string

Course Offering Sid

Pattern: ^CO[a-f0-9]{32}$
​
courseSid
string

Course Sid

Pattern: ^CU[a-f0-9]{32}$
​
examSid
string

Exam Sid

Pattern: ^EX[a-f0-9]{32}$
​
offset
integer

Result offset

Required range: x >= 0
​
limit
integer

Number of items to return

Required range: x >= 0
​
sortKeys
enum<string>[]

Key to sort by

Available options:
createdDate
​
sortOrder
enum<string>
default:ASC

Sort order

Available options:
ASC,
DESC
​
eventSid
string

Event SID

Pattern: ^ER[a-f0-9]{32}$

Response

200 - application/json

Successful

​
total
number | null
​
first
string | null
​
next
string | null
​
prev
string | null
​
last
string | null
​
count
number | null
​
offset
number | null
​
results
object[]