Overview: The Reports category encompasses a suite of powerful endpoints designed to generate a variety of comprehensive reports. These reports provide detailed insights into performance metrics, training effectiveness, module results, user data, and team performance. Whether you're analyzing individual performance, module efficiency, or overall system metrics, these endpoints offer the flexibility to generate the reports you need to drive actionable insights and make data-driven decisions.
Sym Results Report
Retrieve detailed Sym Result Reports, providing system-level performance data and metrics for your analysis. Perfect for understanding the direct impact of Sym on your operations.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · pattern:^\d{4}-\d{2}-\d{2}$· requiredStart date for filtering Direct-sym results report in YYYY-MM-DD format.
endDatestring · date · pattern:^\d{4}-\d{2}-\d{2}$· requiredEnd date for filtering Direct-sym results report in YYYY-MM-DD format. Date range should be within 3 months (180 Days).
orgIdstringID of your Organization
teamIdsstring[]List of team Ids to filter
sequentialIdsstring[]List of sym Ids to filter
userIdsstring[]List of user Ids to filter
symTypesstring[]List of sym types to filter
Enum values:audioVisualchatVisual_chatattemptTypestring · enumAttempt type to Filter
Enum values:PractiseTestpageIndexintegerIndex of the results report
pageSizeintegerNumber of results in report. Max size will be 100.
Responses
Successful response with user results
itemsobject[]List of symtrain records.
totalRecordsCountintegerTotal number of records.
User Results Report
Generate a User Results Report that showcases individual user performance, helping you identify top performers and areas for improvement.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report and should be in YYYY-MM-DD format.
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
orgIdstring · uuidList of organization IDs to filter by
userIdsstring[]List of user IDs to filter by
teamIdsstring[]List of team IDs to filter by
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
Responses
Successful response with user results
itemsobject[]List of user result summary report responses.
totalRecordsCountintegerTotal count of records available for the query.
Training Plan Results Report
Obtain a comprehensive Training Plan Results Report to evaluate the success and outcomes of various training plans, ensuring your teams are on track with their development.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report and should be in YYYY-MM-DD format.
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
trainingPlanIdsstring[]List of training plan IDs to filter by
trainingPlanAssignmentIdsstring[]List of training plan assignment IDs to filter by
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
Responses
Successful response with training plan results
itemsobject[] · requiredList of simulation attempts details
totalRecordsCountstring · requiredTotal number of records returned
Module Results Report
This endpoint provides a Module Results Report, summarizing how different modules have performed and their contribution to the overall system or training efforts.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report and should be in YYYY-MM-DD format
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
orgIdstring · uuidList of organization IDs to filter by
Responses
Successful response with module results
itemsobject[] · requiredList of module details
totalRecordsCountstring · requiredTotal number of records returned
Sym Report
Retrieve the Sym Report, which offers high-level insights into Sym's impact across various components, providing an overview of system performance.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report should be in YYYY-MM-DD format.
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
orgIdstringID of your Organization
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
sequentialIdsinteger[]List of sequential IDs to filter by
symTypesstring[]List of simulation types to filter by
Responses
Successful response with sym reports
itemsobject[] · requiredList of simulation items
totalRecordsCountstring · requiredTotal number of records in the response
Users Report
Generate a Users Report to analyze data for a group of users, focusing on key metrics and providing insights into overall user performance.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report and should be in YYYY-MM-DD format.
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
orgIdstringID of your Organization
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
statusstring · enumThe status to filter by
Enum values:activeinactiveuserIdsstring[]List of user IDs to filter by
teamIdsstring[]List of team IDs to filter by
Responses
Successful response with user reports
itemsobject[] · requiredList of user data items
totalRecordsCountstring · requiredTotal number of records available
Team Results Report
Retrieve a Team Results Report to assess the performance of your teams, helping you make informed decisions on team strategies and improvements.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
startDatestring · date · requiredStart date for the report and should be in YYYY-MM-DD format.
endDatestring · date · requiredEnd date for the report range within 3 months (180 Days) and should be in YYYY-MM-DD format.
orgIdstringID of your Organization
pageIndexintegerThe index of the page to retrieve
pageSizeintegerThe number of items per page. Max size will be 100.
Responses
Successful response with team reports
itemsobject[] · requiredList of team details
totalRecordsCountstring · requiredTotal number of records