edx-enterprise-data 8.9.0__tar.gz → 8.11.0__tar.gz

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/CHANGELOG.rst

@@ -15,6 +15,13 @@ Unreleased
 ----------
 
 =========================
+[8.11.0] - 2024-08-29
+---------------------
+  * perf: Performance enhancements for admin analytics aggregates endpoint.
+
+[8.10.0] - 2024-08-27
+---------------------
+  * feat: Added API endpoints for advance analytics engagements data.
 
 [8.9.0] - 2024-08-23
 ---------------------

{edx_enterprise_data-8.9.0/edx_enterprise_data.egg-info → edx_enterprise_data-8.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 8.9.0
+Version: 8.11.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 8.9.0
+Version: 8.11.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -24,8 +24,16 @@ enterprise_data/admin_analytics/__init__.py
 enterprise_data/admin_analytics/completions_utils.py
 enterprise_data/admin_analytics/constants.py
 enterprise_data/admin_analytics/data_loaders.py
-enterprise_data/admin_analytics/database.py
 enterprise_data/admin_analytics/utils.py
+enterprise_data/admin_analytics/database/__init__.py
+enterprise_data/admin_analytics/database/utils.py
+enterprise_data/admin_analytics/database/queries/__init__.py
+enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py
+enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py
+enterprise_data/admin_analytics/database/tables/__init__.py
+enterprise_data/admin_analytics/database/tables/base.py
+enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py
+enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py
 enterprise_data/api/__init__.py
 enterprise_data/api/urls.py
 enterprise_data/api/v0/__init__.py
@@ -37,6 +45,7 @@ enterprise_data/api/v1/paginators.py
 enterprise_data/api/v1/serializers.py
 enterprise_data/api/v1/urls.py
 enterprise_data/api/v1/views/__init__.py
+enterprise_data/api/v1/views/analytics_engagements.py
 enterprise_data/api/v1/views/analytics_enrollments.py
 enterprise_data/api/v1/views/analytics_leaderboard.py
 enterprise_data/api/v1/views/base.py
@@ -117,6 +126,7 @@ enterprise_data/tests/test_views.py
 enterprise_data/tests/admin_analytics/__init__.py
 enterprise_data/tests/admin_analytics/mock_analytics_data.py
 enterprise_data/tests/admin_analytics/mock_enrollments.py
+enterprise_data/tests/admin_analytics/test_analytics_engagements.py
 enterprise_data/tests/admin_analytics/test_analytics_enrollments.py
 enterprise_data/tests/admin_analytics/test_analytics_leaderboard.py
 enterprise_data/tests/admin_analytics/test_data_loaders.py

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "8.9.0"
+__version__ = "8.11.0"

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/enterprise_data/admin_analytics/constants.py

@@ -31,3 +31,11 @@ class ResponseType(Enum):
     """Response type choices"""
     JSON = 'json'
     CSV = 'csv'
+
+
+class EngagementChart(Enum):
+    """Response Choices"""
+    ENGAGEMENTS_OVER_TIME = 'engagements_over_time'
+    TOP_COURSES_BY_ENGAGEMENTS = 'top_courses_by_engagements'
+    TOP_SUBJECTS_BY_ENGAGEMENTS = 'top_subjects_by_engagements'
+    INDIVIDUAL_ENGAGEMENTS = 'individual_engagements'

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/__init__.py

@@ -0,0 +1,4 @@
+"""
+This module contains the database queries for the admin analytics.
+"""
+from .utils import run_query

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/queries/__init__.py

@@ -0,0 +1,5 @@
+"""
+Module containing queries for the fact_enrollment_admin_dash table.
+"""
+from .fact_engagement_admin_dash import FactEngagementAdminDashQueries
+from .fact_enrollment_admin_dash import FactEnrollmentAdminDashQueries

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py

@@ -0,0 +1,21 @@
+"""
+Module containing queries for the fact_enrollment_engagement_day_admin_dash table.
+"""
+
+
+class FactEngagementAdminDashQueries:
+    """
+    Queries related to the fact_enrollment_engagement_day_admin_dash table.
+    """
+    @staticmethod
+    def get_learning_hours_and_daily_sessions_query():
+        """
+        Get the query to fetch the learning hours and daily sessions.
+        """
+        return """
+            SELECT
+                ROUND(SUM(learning_time_seconds) / 60 / 60, 1) as hours, SUM(is_engaged) as sessions
+            FROM fact_enrollment_engagement_day_admin_dash
+            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
+                activity_date BETWEEN %(start_date)s AND %(end_date)s;
+        """

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py

@@ -0,0 +1,61 @@
+"""
+Module containing queries for the fact_enrollment_admin_dash table.
+"""
+
+
+class FactEnrollmentAdminDashQueries:
+    """
+    Queries related to the fact_enrollment_admin_dash table.
+    """
+
+    @staticmethod
+    def get_enrollment_date_range_query():
+        """
+        Get the query to fetch the enrollment date range.
+        """
+        return """
+            SELECT
+                MIN(enterprise_enrollment_date) AS min_enrollment_date,
+                MAX(enterprise_enrollment_date) AS max_enrollment_date
+            FROM fact_enrollment_admin_dash
+            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s;
+        """
+
+    @staticmethod
+    def get_enrollment_and_course_count_query():
+        """
+        Get the query to fetch the enrollment and course count.
+        """
+        return """
+            SELECT
+                count(*) as enrolls, count(DISTINCT course_key) as courses
+            FROM fact_enrollment_admin_dash
+            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
+                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s;
+        """
+
+    @staticmethod
+    def get_completion_count_query():
+        """
+        Get the query to fetch the completion count.
+        """
+        return """
+            SELECT
+                SUM(has_passed) as completions
+            FROM fact_enrollment_admin_dash
+            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
+                passed_date BETWEEN %(start_date)s AND %(end_date)s;
+        """
+
+    @staticmethod
+    def get_learning_hours_and_daily_sessions_query():
+        """
+        Get the query to fetch the learning hours and daily sessions.
+        """
+        return """
+            SELECT
+                ROUND(SUM(learning_time_seconds) / 60 / 60, 1) as hours, SUM(is_engaged) as sessions
+            FROM fact_engagement_admin_dash
+            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
+                activity_date BETWEEN %(start_date)s AND %(end_date)s;
+        """

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/tables/__init__.py

@@ -0,0 +1,5 @@
+"""
+This module contains the database queries for the admin analytics.
+"""
+from .fact_engagement_admin_dash import FactEngagementAdminDashTable
+from .fact_enrollment_admin_dash import FactEnrollmentAdminDashTable

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/tables/base.py

@@ -0,0 +1,18 @@
+"""
+Base class to store the table information.
+"""
+
+
+class BaseTable:
+    """
+    Singleton class to store the table information.
+    """
+    instance = None
+
+    def __new__(cls):
+        """
+        Singleton method to create a single instance of the table.
+        """
+        if cls.instance is None:
+            cls.instance = super(BaseTable, cls).__new__(cls)
+        return cls.instance

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py

@@ -0,0 +1,38 @@
+"""
+Module for interacting with the fact_enrollment_engagement_day_admin_dash table.
+"""
+from datetime import date
+from uuid import UUID
+
+from ..queries import FactEngagementAdminDashQueries
+from ..utils import run_query
+from .base import BaseTable
+
+
+class FactEngagementAdminDashTable(BaseTable):
+    """
+    Class for communicating with the fact_enrollment_engagement_day_admin_dash table.
+    """
+    queries = FactEngagementAdminDashQueries()
+
+    def get_learning_hours_and_daily_sessions(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+        """
+        Get the learning hours and daily sessions for the given enterprise customer.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            start_date (date): The start date.
+            end_date (date): The end date.
+
+        Returns:
+            (tuple<float, int>): The learning hours and daily sessions.
+        """
+        results = run_query(
+            query=self.queries.get_learning_hours_and_daily_sessions_query(),
+            params={
+                'enterprise_customer_uuid': enterprise_customer_uuid,
+                'start_date': start_date,
+                'end_date': end_date,
+            }
+        )
+        return tuple(results[0])

edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py

@@ -0,0 +1,76 @@
+"""
+Module for interacting with the fact_enrollment_admin_dash table.
+"""
+from datetime import date
+from uuid import UUID
+
+from ..queries import FactEnrollmentAdminDashQueries
+from ..utils import run_query
+from .base import BaseTable
+
+
+class FactEnrollmentAdminDashTable(BaseTable):
+    """
+    Class for communicating with the fact_enrollment_admin_dash table.
+    """
+    queries = FactEnrollmentAdminDashQueries()
+
+    def get_enrollment_date_range(self, enterprise_customer_uuid: UUID):
+        """
+        Get the enrollment date range for the given enterprise customer.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+
+        Returns:
+            (tuple<int, int>): The minimum and maximum enrollment dates.
+        """
+        results = run_query(
+            query=self.queries.get_enrollment_date_range_query(),
+            params={'enterprise_customer_uuid': enterprise_customer_uuid}
+        )
+        return tuple(results[0])
+
+    def get_enrollment_and_course_count(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+        """
+        Get the enrollment and course count for the given enterprise customer.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            start_date (date): The start date.
+            end_date (date): The end date.
+
+        Returns:
+            (tuple<int, int>): The enrollment and course count.
+        """
+        results = run_query(
+            query=self.queries.get_enrollment_and_course_count_query(),
+            params={
+                'enterprise_customer_uuid': enterprise_customer_uuid,
+                'start_date': start_date,
+                'end_date': end_date,
+            }
+        )
+        return tuple(results[0])
+
+    def get_completion_count(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+        """
+        Get the completion count for the given enterprise customer.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            start_date (date): The start date.
+            end_date (date): The end date.
+
+        Returns:
+            int: The completion count.
+        """
+        results = run_query(
+            query=self.queries.get_completion_count_query(),
+            params={
+                'enterprise_customer_uuid': enterprise_customer_uuid,
+                'start_date': start_date,
+                'end_date': end_date,
+            }
+        )
+        return results[0][0]

edx_enterprise_data-8.9.0/enterprise_data/admin_analytics/database.py → edx_enterprise_data-8.11.0/enterprise_data/admin_analytics/database/utils.py

@@ -30,12 +30,13 @@ def get_db_connection(database=settings.ENTERPRISE_REPORTING_DB_ALIAS):
 
 
 @timeit
-def run_query(query):
+def run_query(query, params: dict = None):
     """
     Run a query on the database and return the results.
 
     Arguments:
         query (str): The query to run.
+        params (dict): The parameters to pass to the query.
 
     Returns:
         (list): The results of the query.
@@ -43,7 +44,7 @@ def run_query(query):
     try:
         with closing(get_db_connection()) as connection:
             with closing(connection.cursor()) as cursor:
-                cursor.execute(query)
+                cursor.execute(query, params=params)
                 return cursor.fetchall()
     except Exception:
         LOGGER.exception(f'[run_query]: run_query failed for query "{query}".')

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/enterprise_data/api/v1/serializers.py

@@ -5,7 +5,13 @@ from uuid import UUID
 
 from rest_framework import serializers
 
-from enterprise_data.admin_analytics.constants import Calculation, EnrollmentChart, Granularity, ResponseType
+from enterprise_data.admin_analytics.constants import (
+    Calculation,
+    EngagementChart,
+    EnrollmentChart,
+    Granularity,
+    ResponseType,
+)
 from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
@@ -331,3 +337,27 @@ class AdvanceAnalyticsEnrollmentStatsSerializer(
         if value not in self.CHART_TYPES:
             raise serializers.ValidationError(f"chart_type must be one of {self.CHART_TYPES}")
         return value
+
+
+class AdvanceAnalyticsEngagementStatsSerializer(
+    AdvanceAnalyticsQueryParamSerializer
+):  # pylint: disable=abstract-method
+    """Serializer for validating Advance Analytics Engagements Stats API"""
+    CHART_TYPES = [
+        EngagementChart.ENGAGEMENTS_OVER_TIME.value,
+        EngagementChart.TOP_COURSES_BY_ENGAGEMENTS.value,
+        EngagementChart.TOP_SUBJECTS_BY_ENGAGEMENTS.value
+    ]
+
+    chart_type = serializers.CharField(required=False)
+
+    def validate_chart_type(self, value):
+        """
+        Validate the chart_type value.
+
+        Raises:
+            serializers.ValidationError: If chart_type is not one of the valid choices
+        """
+        if value not in self.CHART_TYPES:
+            raise serializers.ValidationError(f"chart_type must be one of {self.CHART_TYPES}")
+        return value

{edx_enterprise_data-8.9.0 → edx_enterprise_data-8.11.0}/enterprise_data/api/v1/urls.py

@@ -11,6 +11,10 @@ from enterprise_data.api.v1.views import enterprise_admin as enterprise_admin_vi
 from enterprise_data.api.v1.views import enterprise_completions as enterprise_completions_views
 from enterprise_data.api.v1.views import enterprise_learner as enterprise_learner_views
 from enterprise_data.api.v1.views import enterprise_offers as enterprise_offers_views
+from enterprise_data.api.v1.views.analytics_engagements import (
+    AdvanceAnalyticsEngagementStatsView,
+    AdvanceAnalyticsIndividualEngagementsView,
+)
 from enterprise_data.api.v1.views.analytics_enrollments import (
     AdvanceAnalyticsEnrollmentStatsView,
     AdvanceAnalyticsIndividualEnrollmentsView,
@@ -73,6 +77,16 @@ urlpatterns = [
         AdvanceAnalyticsIndividualEnrollmentsView.as_view(),
         name='enterprise-admin-analytics-enrollments'
     ),
+    re_path(
+        fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/engagements/stats$',
+        AdvanceAnalyticsEngagementStatsView.as_view(),
+        name='enterprise-admin-analytics-engagements-stats'
+    ),
+    re_path(
+        fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/engagements$',
+        AdvanceAnalyticsIndividualEngagementsView.as_view(),
+        name='enterprise-admin-analytics-engagements'
+    ),
     re_path(
         fr'^admin/analytics/(?P<enterprise_id>{UUID4_REGEX})/skills/stats',
         enterprise_admin_views.EnterpriseAdminAnalyticsSkillsView.as_view(),