Advanced Analytics with the Skillhabit API

Overview

The Skillhabit Analytics API allows you to extract detailed learning data and replicate dashboard-level insights directly in your own systems. With advanced filtering and flexible queries, you can build custom reports, dashboards, and integrations tailored to your organization.

What is the Analytics API?

The POST /analyse/results endpoint is a powerful data retrieval tool that provides access to user participation and progress across your workspace.

Unlike standard exports, this endpoint supports advanced filtering, enabling you to recreate the same reports available in the Skillhabit "Analyse" interface within your own tools or BI platforms.

How It Works

You can retrieve a paginated list of user results by sending a JSON request with your selected filters.

1. Filtering Options

You can refine your data using multiple parameters:

• Targeting – Filter by groupIds, userIds, or contentIds
• Progress states – Filter by status:
  • NOT_STARTED
  • IN_PROGRESS
  • APPROVED
  • FAILED
  • EXPIRED
• Enrollment types – Filter by:
  • MANDATORY
  • OPTIONAL
  • NOT_ENROLLED
• Custom attributes – Filter using workspace-specific fields (e.g., Department, Region, Job Title)
• Date ranges – Filter by:
  • updatedAtDateRange
  • expiryDateRange

2. Pagination and Sorting

To manage large datasets, use the options object:

• Limit & Skip – Control how many records are returned per request
• Ordering – Sort results by fields such as updatedAt in:
  • ASC (ascending)
  • DESC (descending)

3. Response Data

The API returns a structured JSON response with detailed information for each result, including:

• Content details – Name, ID, and type
• User information – Name, email, and avatar
• Completion data – Progress percentage, state, and timestamps (e.g., certificateIssuedAt)

Use Cases

By leveraging the Analytics API, you can:

• Build custom BI dashboards
• Automate compliance and reporting workflows
• Trigger actions based on learner progress (e.g., course failures)
• Sync learning data with HR systems (HRIS)

Permissions

To access the Analytics API:

• A valid Bearer Token (JWT) is required
• API access must be enable

Best Practices

• Use attribute IDs – Always reference the correct customFieldId when filtering by custom fields
• Batch requests – Use limit and skip to handle large datasets efficiently
• Combine endpoints – Use POST /analyse/statistics for high-level insights before fetching detailed results

Availability

Advanced Analytics API endpoints are available for Enterprise workspaces.

For full technical documentation, visit: customer-api.skillhabit.com