Tutorials

Generating Your First Report Tutorial

Copy page

← Back to Tutorials

Overview

Learn how to generate performance reports and handle pagination effectively.

Duration: 15 minutes | Level: Beginner

---

Prerequisites

• ✅ API key configured
• ✅ Completed Getting Started tutorial
• ✅ Organization ID

---

Available Report Types

1. Sym Results Report - System-level performance
2. User Results Report - Individual user performance
3. Training Plan Results - Training plan effectiveness
4. Module Results - Module performance data
5. Team Results - Team performance metrics

---

Step 1: Generate a User Results Report

Code
 
curl -X POST https://api.symtrain.com/v2/report/user-results \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": "2024-10-01",
    "endDate": "2024-12-31"
  }'

Important: Date range must not exceed 3 months (180 days).

---

Step 2: Handle Pagination

Reports may contain more than 100 records. Handle pagination:

Code
 
async function getAllUserResults(startDate, endDate) {
  let allResults = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await fetch(
      "https://api.symtrain.com/v2/report/user-results",
      {
        method: "POST",
        headers: {
          Authorization: `Bearer ${API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify({
          startDate,
          endDate,
          page,
          pageSize: 100,
        }),
      }
    );

    const data = await response.json();
    allResults = allResults.concat(data.results);

    hasMore = data.results.length === data.pageSize;
    page++;
  }

  return allResults;
}

---

Step 3: Interpret Report Data

User Results Report Structure:

Code
 
{
  "results": [
    {
      "userId": "user-123",
      "userName": "John Doe",
      "email": "[email protected]",
      "completedSimulations": 5,
      "averageScore": 85.5,
      "totalAttempts": 8,
      "lastCompletedDate": "2024-10-15"
    }
  ],
  "totalRecordsCount": 250,
  "page": 1,
  "pageSize": 100
}

Key Metrics:

• completedSimulations: Number of successfully completed simulations
• averageScore: Average score across all attempts
• totalAttempts: Total simulation attempts (including incomplete)

---

Testing

• Generated a report successfully
• Handled pagination for large result sets
• Respected 3-month date range limit
• Interpreted report metrics correctly

---

Next Steps

• Bulk User Import Tutorial
• Best Practices Guide
• API Reference - Reports

---

← Back to Tutorials | Next: Bulk Import →