Sign in

v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Reports

Service Distribution

Returns a service distribution report for the specified install.

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

Path parameters

installSidstring required

Install Sid

Install Sid

Query parameters

serviceTypesstring[]

Types of services to include in the report

Types of services to include in the report

statusesstring[]

Statuses to include in the report

Statuses to include in the report

courseOfferingSidstring

Course offering sid

Course offering sid

courseSidstring

Course sid

Course sid

courseTitlestring

Course title

Course title

courseCodestring

Course code

Course code

examTitlestring

Exam title

Exam title

examSidstring

Exam sid

Exam sid

appointmentDateAfterstring

Appointments after date (inclusive)

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

Appointments after date (inclusive)

appointmentDateBeforestring

Appointments before date (exclusive)

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

Appointments before date (exclusive)

closeDateAfterstring

Close date after (inclusive)

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

Close date after (inclusive)

closeDateBeforestring

Close date before (exclusive)

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

Close date before (exclusive)

userSidstring

User sid

User sid

billableboolean

Filter by billable sessions

Filter by billable sessions

offsetinteger

Result offset

Result offset

limitinteger

Number of items to return

Number of items to return

sortKeysstring[]

Key to sort by

Key to sort by

sortOrder'ASC' | 'DESC'

Sort order

Sort order

Response

Successful

totalnumber nullable

Total results

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