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

Aggregated

Get Departments Aggregated

GET /sessions/aggregation/departments

https://api.relesystest.net/api/v1.4/sessions/aggregation/departments

Get Sessions aggregated for a period and per department.

Time Interval:
All data returned is between DateFrom and DateTo, the dates are inclusive
Department Type:
"Company", "Country", "Department", "District", "Division", "Other", "Partner", "Region", "Store", "Subdepartment"
SubDepartments:
If set to true, a DeparmentId is required to get aggregated data for all individual subdepartments

Scopes: relesys.api, relesys.api:read, relesys.api.insights, relesys.api.insights:read

Query String

dateFrom	datetime	`Filterable`		required
dateTo	datetime	`Filterable`		required
departmentId	string / guid	`Filterable`		optional
departmentType	string	`Filterable`		optional
subDepartments	boolean	`Filterable`		optional

Responses

application/json

Schema Example

JSON

{"totalUsers":250,"totalUsersWithSessions":0,"departments":[{"users":98,"usersWithSessions":20,"departmentName":"Department A","departmentType":"Store","departmentId":"5e165654-8e1b-42e8-8795-0d1cfe082e41"},{"users":102,"usersWithSessions":87,"departmentName":"Department B","departmentType":"Region","departmentId":"9044e903-4d36-4942-b93a-537d4c86c7ea"}]}

object
⯈ departments	array[object]
departmentId	string / guid
departmentName	string
departmentType	string
users	integer
usersWithSessions	integer
totalUsers	integer
totalUsersWithSessions	integer