[Assistance Required] Sunbird LMS API Documentation for User Dashboards

[komalm]

Hello @HarishGangula @pallakartheekreddy,

I am currently working on building dashboards for user engagement and demographic analysis in Sunbird LMS. While I have identified several APIs that seem relevant, I have not been able to find detailed Sunbird documentation on their implementation. When I queried the Sunbird bot, I received some information, but it was not comprehensive enough for our use case.

Requirements & Findings

A] User-Focused Dashboards

1. Daily Active Users (DAU) Dashboard

   • API Found: /data/v1/dashboard/metrics/dailyActiveUsers
   • Requirement: Real-time tracking and analysis of daily user engagement.
   • Details Needed: Expected request parameters, response format, and example responses.
     

2. User Demographics Dashboard

   • API Found: /data/v1/dashboard/demographics
   • Requirement: Insights into user demographics, including age, gender, location, and education level.
   • Details Needed: Specific data fields provided, filtering options, and how this data is collected.
     

3. Session Duration Dashboard

   • API Found: /data/v1/dashboard/metrics/sessionDuration
   • Requirement: Analysis of average session duration per user.
   • Details Needed: What telemetry events contribute to session tracking and response structure.
     

B] Telemetry-Based User Tracking

1. User Consumption Metrics

   • API Found: /data/v1/dashboard/consumption/usage/users
   • Requirement: Track how users interact with content (views, time spent, interactions).
   • Details Needed: Expected input parameters and example JSON responses.
     

2. Current Active Users

   • API Found: /v1/telemetry/metrics/users/current
   • Requirement: Real-time count of active users.
   • Details Needed: How frequently this data is updated and response structure.
     

3. User Engagement Metrics

   • API Found: GET /v1/telemetry/metrics/users/engagement
   • Requirement: Detailed engagement metrics, including time spent and user interaction patterns.
   • Details Needed: Available filters, breakdown of engagement metrics, and sample API calls.

Request for Documentation & Clarifications
I would appreciate it if you could provide:

1. Official API documentation with details on request parameters, response formats, and use cases.
2. Examples of API requests and responses to understand the data structure better.
3. Any additional guidance on how telemetry data is processed and stored in Sunbird LMS.

Looking forward to your response.