Relesys API Docs

Endpoints

Calendar
- Categories
  - Get GET
  - List GET
- Events
  - Get GET
  - List GET
- Participation
  - Get GET
  - List GET
Communication
- Messages
  - Send Message POST
- Notifications
  - Get Channels GET
  - Send Notifications POST
- Templates
  - Get Template GET
  - Get Templates GET
Content
- Categories
  - Get Content Categories GET
  - Get Content Category By Id GET
- Comments
  - Reactions
    - Get Comment Reactions GET
  - Get Comment By Id GET
  - Get Comments GET
- Reactions
  - Get Content Reactions GET
- Views
  - Get Content Views GET
Data Lists
- Custom Fields
  - Get Custom Field GET
  - Get Custom Fields GET
- Items
  - Get Data List Item GET
  - Get Data List Items GET
- Get Data List GET
- Get Data Lists GET
Global
- Cultures
  - Get Cultures GET
- Time Zones
  - Get Time Zones GET
Highscores
- Levels
  - Get Level GET
  - Get Levels GET
- Points
  - Aggregated
    - Get Departments' Total Points GET
    - Get Users' Total Points GET
- Get GET
- List GET
KPI Management
- Data Points
- Data Sets
  - Get Data Set GET
  - Get Data Sets GET
Media
- Get Media By Id GET
- Upload Media POST
Member Cards
- Get GET
- List GET
Service Form
- Forms
  - Answer Feedback
    - Get GET
    - List GET
  - Answer Feedback Comments
    - Get GET
    - List GET
  - Answers
    - Get GET
    - List GET
  - Field Groups
    - Get GET
    - List GET
  - Fields
    - Get GET
    - List GET
  - Filling Comments
    - Get GET
    - List GET
  - Filling Feedback
    - Get GET
    - List GET
  - Filling Feedback Comments
    - Get GET
    - List GET
  - Filling Reactions
    - Get GET
    - List GET
  - Fillings
    - Get GET
    - List GET
  - Pages
    - Get GET
    - List GET
  - Performance Ranges
    - Get GET
    - List GET
  - Score Categories
    - Get GET
    - List GET
  - Stage Comments
    - Get GET
    - List GET
  - Stage Reviews
    - Get GET
    - List GET
  - Stages
    - Get GET
    - List GET
  - Get GET
  - List GET
- Modules
  - Get GET
  - List GET
Sessions
- Aggregated
  - Get Departments Aggregated GET
  - Get Devices Aggregated GET
- Get Sessions GET
Surveys
- Answers
  - List Survey Answers GET
- Instances
  - Sentiments
    - List GET
  - Get GET
  - List GET
- Questions
  - List GET
- Survey Modules
  - List GET
- Get GET
- List GET
Task Management
- Completions
  - List GET
- Series
  - List GET
- Subtasks
  - Subtask Completions
    - List GET
  - List GET
- Task Management Modules
  - Module Categories
    - List GET
  - List GET
Training
- Courses
  - Get Course Statistics GET
  - Get Courses GET
- Lessons
- Modules
  - Get Module Statistics GET
  - Get Modules GET
- Phases
  - Get Phases GET
User Management
- Custom Fields
  - Get User Custom Fields GET
- Departments
- User Groups
- Users

Courses

Get Course Statistics

GET /training/courses/statistics

https://api.uat.relesystest.net/api/v1.4/training/courses/statistics

Get a list of Course Statistics for participation - including calculated values for users without any completions.

Scopes: relesys.api, relesys.api:read, relesys.api.training, relesys.api.training:read

Query String

completionRate	double	`Filterable` `Sortable`		optional
courseId	string / guid	`Filterable`		optional
courseParticipationState	string	`Filterable` `Sortable`		optional
creationDateTime	datetimeoffset	`Filterable` `Sortable`		optional
lastModifiedDateTime	datetimeoffset	`Filterable` `Sortable`		optional
performanceScore	double	`Filterable` `Sortable`		optional
points	integer	`Filterable` `Sortable`		optional
userId	string / guid	`Filterable`		optional
sort	string	Comma separated sort order based on sortable properties		optional
offset	integer	Offset value for use in pagination	Default: 0	optional
limit	integer	Total objects to fetch (max 1000)	Default: 200	optional

Responses

application/json

Schema Example

JSON

{"count":2,"data":[{"courseId":"a742d2d0-3759-4dae-9e31-44eb6e196b11","userId":"f2c7b8f8-7151-46cd-ae2d-da84f1af672e","courseParticipationState":"Completed","creationDateTime":"2020-06-02T22:00:00+00:00","lastModifiedDateTime":"2020-11-08T22:00:00+00:00","completionRate":1.0,"performanceScore":0.9,"points":5},{"courseId":"b4699170-0c17-4abd-8a45-16c5fdcb4e91","userId":"9eeec0ba-9a65-4a9b-b1f1-ab74defc9252","courseParticipationState":"Not Started","creationDateTime":"2020-06-02T22:00:00+00:00","lastModifiedDateTime":"2020-11-08T22:00:00+00:00","completionRate":0.0,"performanceScore":null,"points":0}]}

object
count	integer
⯈ data	array[object]
completionRate	double
courseId	string / guid
courseParticipationState	string
creationDateTime	datetimeoffset
lastModifiedDateTime	datetimeoffset
performanceScore	double
points	integer
userId	string / guid
nextUrl	string
previousUrl	string