SMsmarterproctoring
Reports

Service Distribution

Returns a service distribution report for the specified install.

get/v1/installs/{installSid}/reports/serviceDistribution

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/reports/serviceDistribution
  • Auth
    API key in header token

Path parameters

installSidstring required

Install Sid

Query parameters

serviceTypesstring[]

Types of services to include in the report

statusesstring[]

Statuses to include in the report

courseOfferingSidstring

Course offering sid

courseSidstring

Course sid

courseTitlestring

Course title

courseCodestring

Course code

examTitlestring

Exam title

examSidstring

Exam sid

appointmentDateAfterstring

Appointments after date (inclusive)

Example:1970-01-01T00:00:00.000Z
appointmentDateBeforestring

Appointments before date (exclusive)

Example:1970-01-01T00:00:00.000Z
closeDateAfterstring

Close date after (inclusive)

Example:1970-01-01T00:00:00.000Z
closeDateBeforestring

Close date before (exclusive)

Example:1970-01-01T00:00:00.000Z
userSidstring

User sid

billableboolean

Filter by billable sessions

offsetinteger

Result offset

limitinteger

Number of items to return

sortKeysstring[]

Key to sort by

sortOrder'ASC' | 'DESC'

Sort order

Response

Successful

totalnumber nullable

Total results

firststring nullable
nextstring nullable
prevstring nullable
laststring nullable
countnumber nullable
offsetnumber nullable

Changes

No recorded changes to this operation across all 13 revisions of this API.