edx-enterprise-data 8.9.0__py3-none-any.whl → 8.11.0__py3-none-any.whl

{edx_enterprise_data-8.9.0.dist-info → edx_enterprise_data-8.11.0.dist-info}/METADATA

@@ -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.dist-info → edx_enterprise_data-8.11.0.dist-info}/RECORD

@@ -1,20 +1,28 @@
-enterprise_data/__init__.py,sha256=Zxnoju6lsQu0H9GDmX4En0Gmk8P-gBTSZJ-96C3W-0E,123
+enterprise_data/__init__.py,sha256=43cEhgzFHOpsMk6l_FF2WJGDjIlxTPg6xfJU8UsyHrA,124
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
 enterprise_data/clients.py,sha256=GvQupy5TVYfO_IKC3yzXSAgNP54r-PtIjidM5ws9Iks,3947
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
 enterprise_data/filters.py,sha256=D2EiK12MMpBoz6eOUmTpoJEhj_sH7bA93NRRAdvkDVo,6163
 enterprise_data/models.py,sha256=khGcOh7NWP8KGu84t78Y2zAu3knREeXA_prApmU2NX8,24428
 enterprise_data/paginators.py,sha256=YPrC5TeXFt-ymenT2H8H2nCbDCnAzJQlH9kFPElRxWE,269
-enterprise_data/renderers.py,sha256=9gIzavWspZTk4vDfVKXJtdn0tSZ2xNgkF-Akf7AWIDM,2389
+enterprise_data/renderers.py,sha256=VaCymaZUhYEZ6yvryoASEohKeeL6lcPSWhFCnyfzjps,2699
 enterprise_data/signals.py,sha256=8eqNPnlvmfsKf19lGWv5xTIuBgQIqR8EZSp9UYzC8Rc,1024
 enterprise_data/urls.py,sha256=bqtKF5OEWEwrNmHG3os-pZNuNsmjlhxEqp7yM4TbPf4,243
 enterprise_data/utils.py,sha256=_zK3BErjZSIkP_JNzK8m-DR5pRTnxKylP9I-vURaRcE,3009
 enterprise_data/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/admin_analytics/completions_utils.py,sha256=kGmLy7x6aD0coNYgzLa5XzJypLkGTT5clDHLSH_QFDE,9442
-enterprise_data/admin_analytics/constants.py,sha256=aHDgTHdsjbKNpgtNLDsl4giqhhrRkCGi72ysGIEk0Ao,817
+enterprise_data/admin_analytics/constants.py,sha256=7WturLuMISekgcHHlgj45PPdPrDTYM-l21lA8-Q_Tfc,1107
 enterprise_data/admin_analytics/data_loaders.py,sha256=4PSsIveNBtpFqwrLUjTl5oywHVYFAMdZrNRHRGMk4XY,6116
-enterprise_data/admin_analytics/database.py,sha256=mNS_9xE5h6O7oMMzr6kr6LDTTSNvKzo8vaM-YG8tOd8,1312
 enterprise_data/admin_analytics/utils.py,sha256=CQuTlg36AALJiopp4us-JN8oTXsw-jDXSJenbphLDME,12270
+enterprise_data/admin_analytics/database/__init__.py,sha256=vNSWKf2VV5xMegN7htJJtxtQEb0ASLC6frE2w0ZpYpE,104
+enterprise_data/admin_analytics/database/utils.py,sha256=Zl-W_w5SVb-QpIwWxbHr0w7z4L2ZFeruJSygWh8g7II,1408
+enterprise_data/admin_analytics/database/queries/__init__.py,sha256=IC5TLOr_GnydbrVbl2mWhwO3aUbYeHuDmfPTLmwGhZA,218
+enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py,sha256=fq01Ni_sKnvSRoiPQfTnJ8TtRePQe5MBLmI5CpVy36o,747
+enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py,sha256=X1muOEhEvqD-tyhrVEQkPrf8_7g7SPaJuMwriUPo3jw,2062
+enterprise_data/admin_analytics/database/tables/__init__.py,sha256=3ECKlKlz1wuTER5M57CMFvmLFp0oCnVQXAUeTN96Bs0,213
+enterprise_data/admin_analytics/database/tables/base.py,sha256=1KyKsC18pW3m-5U-T6pdt5rIwsz6Wp3QFFbD3r6L6YQ,395
+enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py,sha256=EsG8KgRW84wtA_nJuUknjLYlDtaPSJf_9mWdkO2Bj2I,1293
+enterprise_data/admin_analytics/database/tables/fact_enrollment_admin_dash.py,sha256=SLnhWEfbQfeaUWT1a7H5ZCTq3XMMrzO_6iG-g6kMry4,2571
 enterprise_data/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/urls.py,sha256=POqc_KATHdnpMf9zHtpO46pKD5KAlAExtx7G6iylLcU,273
 enterprise_data/api/v0/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
@@ -23,14 +31,15 @@ enterprise_data/api/v0/urls.py,sha256=vzJjqIo_S3AXWs9Us8XTaJc3FnxLbYzAkmLyuDQqum
 enterprise_data/api/v0/views.py,sha256=4RslZ4NZOU-844bnebEQ71ji2utRY7jEijqC45oQQD0,14380
 enterprise_data/api/v1/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
 enterprise_data/api/v1/paginators.py,sha256=f0xsilLaU94jSBltJk46tR1rLEIt7YrqSzMAAVtPXjA,3592
-enterprise_data/api/v1/serializers.py,sha256=9F2LGa8IKvglgeYNHw3Q0eEZUWknwHZMNZOdpDviEo4,12327
-enterprise_data/api/v1/urls.py,sha256=xFsBf3TTsdblFAiHq1Bj3h82Ye1PS3cgqLC0pIso2js,3504
+enterprise_data/api/v1/serializers.py,sha256=Kk4zuRNcr4bfMYIwi2iXQAr_NM3OXuXNfxfrz7xO2iE,13194
+enterprise_data/api/v1/urls.py,sha256=nFcbPSfAIKW6Eiwd1vN0WMqdtBfh9_bBqAFCVrzRm5I,4091
 enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enterprise_data/api/v1/views/analytics_enrollments.py,sha256=om8i5HTDxDMSny1fy49Wh38LdYLLz-k-oFQJqlQLOxg,16812
-enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=EE34fJWYp8OGbIj8oRLlgMhbSm37w98oPXn1aPIZWWE,5860
+enterprise_data/api/v1/views/analytics_engagements.py,sha256=8H3Fk-hTqJaU3H5Lpu1kFWq7p7xDp1pjge-sK7osDbg,17553
+enterprise_data/api/v1/views/analytics_enrollments.py,sha256=trC92GOej6vUoju53KT3dPEDnoPHdukfXEIXPThz76A,16886
+enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=2DALqzUIbe4-ZGgHHIkYAKJ5L1ik2ruPtQNYtTdPba4,5974
 enterprise_data/api/v1/views/base.py,sha256=FTAxlz5EzvAY657wzVgzhJPFSCHHzct7IDcvm71Smt8,866
-enterprise_data/api/v1/views/enterprise_admin.py,sha256=F34FbOz1gLwHPUAQOg3mOjZoKirbCRrjZS2xFJSUBpw,9274
-enterprise_data/api/v1/views/enterprise_completions.py,sha256=OkH6eYNql6UGVU-Xjx7PzwzaHeUHfa6e4WJmkUoHGDM,8221
+enterprise_data/api/v1/views/enterprise_admin.py,sha256=_HfQ46bIC6uU3knCWhGLnsWf_YGtsjYHU5UrwG6sdfA,8568
+enterprise_data/api/v1/views/enterprise_completions.py,sha256=bJG2ZtTbLyiBrj64iJHQNHEKLrJCzl9OuJ7nDtw-9aY,8377
 enterprise_data/api/v1/views/enterprise_learner.py,sha256=yABjJje3CT8I8YOhWr1_tTkdKtnGJom8eu3EFz_-0BU,18517
 enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
 enterprise_data/fixtures/enterprise_enrollment.json,sha256=6onPXXR29pMdTdbl_mn81sDi3Re5jkLUZz2TPMB_1IY,5786
@@ -104,8 +113,9 @@ enterprise_data/tests/test_models.py,sha256=MWBY-LY5TPBjZ4GlvpM-h4W-BvRKr2Rml8Bz
 enterprise_data/tests/test_utils.py,sha256=vbmYM7DMN-lHS2p4yaa0Yd6uSGXd2qoZRDE9X3J4Sec,18385
 enterprise_data/tests/test_views.py,sha256=UvDRNTxruy5zBK_KgUy2cBMbwlaTW_vkM0-TCXbQZiY,69667
 enterprise_data/tests/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enterprise_data/tests/admin_analytics/mock_analytics_data.py,sha256=mLGTIP89VAQgqKtYlYnKUAKyZATzKnBtI_5aJwMmr7Q,18344
+enterprise_data/tests/admin_analytics/mock_analytics_data.py,sha256=LoYAh5cn_4rv2stGcMP5PELv2l7Eu2DTKG-v7viNTCs,20266
 enterprise_data/tests/admin_analytics/mock_enrollments.py,sha256=LfuMo9Kn-OQD4z42G3BRuM5MXUUXXlaAMhTqfJf46XE,7266
+enterprise_data/tests/admin_analytics/test_analytics_engagements.py,sha256=KPXtBPaAOrzfff7W-xERSGx9KtZAJndLbIJx3gopSnE,15689
 enterprise_data/tests/admin_analytics/test_analytics_enrollments.py,sha256=UdKRkP6BNbsSo-gm0YCoddT-ReUMI1x9E6HNLSHT7pY,15177
 enterprise_data/tests/admin_analytics/test_analytics_leaderboard.py,sha256=VSEyDAHfWBJvqmx9yzd4NnPAqK3TqaKrMBWswMAdzfU,6206
 enterprise_data/tests/admin_analytics/test_data_loaders.py,sha256=o3denJ4aUS1pI5Crksl4C6m-NtCBm8ynoHBnLkf-v2U,4641
@@ -118,7 +128,7 @@ enterprise_data/tests/api/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NM
 enterprise_data/tests/api/v1/test_serializers.py,sha256=DwgEHcyOP3oqNUPB2O-NkJGeO_cYs9XJiq7791vJLZE,3682
 enterprise_data/tests/api/v1/test_views.py,sha256=rLqUHfar0HdBNtz33hQxd_0qUUgr7Ku3KwQSQ1B4Ypg,15213
 enterprise_data/tests/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enterprise_data/tests/api/v1/views/test_enterprise_admin.py,sha256=At4g5Q4W4SNPk693HxuoEOHtMehvkscLvtXV4dbivvE,4969
+enterprise_data/tests/api/v1/views/test_enterprise_admin.py,sha256=i0A1JqG1YQTVRiXviFPbx385p7YhMxew72lgTZ7YNEg,6173
 enterprise_data_roles/__init__.py,sha256=toCpbypm2uDoWVw29_em9gPFNly8vNUS__C0b4TCqEg,112
 enterprise_data_roles/admin.py,sha256=QNP0VeWE092vZzpyxOA5UJK1nNGl5e71B1J0RCwo_nU,998
 enterprise_data_roles/apps.py,sha256=nKi8TyuQ5Q6WGtKs5QeXvUTc3N-YQjKhyBnm2EM3Bng,260
@@ -159,8 +169,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PP
 enterprise_reporting/tests/test_utils.py,sha256=Zt_TA0LVb-B6fQGkUkAKKVlUKKnQh8jnw1US1jKe7g8,9493
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-8.9.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-8.9.0.dist-info/METADATA,sha256=UTWat3hOmN-XCrlQYPFRaNeyVtqtigs8ZUkDs8dmJWo,1569
-edx_enterprise_data-8.9.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-edx_enterprise_data-8.9.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-8.9.0.dist-info/RECORD,,
+edx_enterprise_data-8.11.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-8.11.0.dist-info/METADATA,sha256=21GMLdFJo9VqGsBOCJgld3rUyVhCwGTZPXEYjPb3Ou4,1570
+edx_enterprise_data-8.11.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+edx_enterprise_data-8.11.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-8.11.0.dist-info/RECORD,,

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"

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'

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

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

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;
+        """

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;
+        """

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

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

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])

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]

enterprise_data/admin_analytics/{database.py → 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}".')

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

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(),