Symtrain Public APIs - Version 1
This is the documentation for Symtrain Public APIs Version 1.
Overview
The Version 1 API provides access to:
- Reports: APIs that allow you to fetch various performance and result-based reports.
- Access API: Endpoints to generate deep links for simulations and query simulation execution scores.
Base URL
Code
Authentication
All API endpoints require authentication using a Bearer token in the Authorization header:
Code
Getting Started
- Obtain your API Key from the Symtrain support team
- Review the API Reference v1 for detailed endpoint documentation
- Start making requests to the API endpoints
Key Features
Reports
POST /report/syms-result
Retrieve detailed Sym Result Reports, providing system-level performance data and metrics for your analysis.
POST /report/user-results
Generate a User Results Report that showcases individual user performance, helping you identify top performers and areas for improvement.
POST /report/training-plan-result
Obtain a comprehensive Training Plan Results Report to evaluate the success and outcomes of various training plans.
POST /report/modules-results
Get a Module Results Report, summarizing how different modules have performed and their contribution to the overall system.
POST /report/syms
Retrieve the Sym Report, which offers high-level insights into Sym's impact across various components.
POST /report/users
Generate a Users Report to analyze data for a group of users, focusing on key metrics and overall user performance.
POST /report/teams-result
Retrieve a Team Results Report to assess the performance of your teams.
Common Request Body for Reports:
startDate(required) - Start date (format: YYYY-MM-DD)endDate(required) - End date (format: YYYY-MM-DD)- Date range must be within 3 months (180 days)
Access API
POST /access-api/simulation/deep-links
Generate simulation deep-links that users can use to directly access and run specific simulations in SymTrain.
Request Body:
organizationId(required) - Organization identifieruserId(required) - User identifiersimulationId(required) - Simulation identifier
Returns: Deep-link URL for simulation access
POST /access-api/simulation/completion-data
Retrieve Completion Data for simulation executions (started, interrupted, and completed) for a specific user and simulation.
Request Body:
organizationId(required) - Organization identifieruserId(required) - User identifiersimulationId(required) - Simulation identifier
Returns: All execution attempts with scores (for completed) and execution details
Rate Limiting
- 100 requests per 5-minute window per IP address
429 Too Many Requestsresponse when limit exceeded
Common Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request - Invalid data or missing parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource not found |
| 500 | Internal Server Error - Server-side issue |
Support
For questions or issues, contact our support team at: [email protected]
📖 Full API Reference
For complete interactive API documentation with all endpoints, request/response schemas, and the ability to test endpoints:
View Complete API v1 Reference →
Next Steps
- Migration Guide - Upgrade from v1 to v2