edx-enterprise-data 8.6.0__py3-none-any.whl → 8.7.0__py3-none-any.whl

{edx_enterprise_data-8.6.0.dist-info → edx_enterprise_data-8.7.0.dist-info}/METADATA

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

{edx_enterprise_data-8.6.0.dist-info → edx_enterprise_data-8.7.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-enterprise_data/__init__.py,sha256=EPPAk93ePtVZFtG1D6BcUQ1SPs07JiPQCLJhZ41gW-Y,123
+enterprise_data/__init__.py,sha256=uaNc7nZk0jrnfiaQzk9MA9gKcNIQ30m99eUJ0R4k1X8,123
 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
@@ -10,10 +10,11 @@ enterprise_data/signals.py,sha256=8eqNPnlvmfsKf19lGWv5xTIuBgQIqR8EZSp9UYzC8Rc,10
 enterprise_data/urls.py,sha256=bqtKF5OEWEwrNmHG3os-pZNuNsmjlhxEqp7yM4TbPf4,243
 enterprise_data/utils.py,sha256=kNO4nW_GBpBiIBlVUkCb4Xo0k1oVshT8nDOBP5eWoV8,2643
 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=6Gc9rP-J3nGgAk3fhzNlyR1HMq8Apjxs9ViWJiYrri4,722
 enterprise_data/admin_analytics/data_loaders.py,sha256=x1XNYdtJV1G9cv0SeBZqYitRV8-GlJXtEZ2cc2OJU7M,5415
 enterprise_data/admin_analytics/database.py,sha256=mNS_9xE5h6O7oMMzr6kr6LDTTSNvKzo8vaM-YG8tOd8,1312
-enterprise_data/admin_analytics/utils.py,sha256=65HjDdNJkQTHqS6KatHE4UpEzKDMj2_v21O-YBf130Q,10023
+enterprise_data/admin_analytics/utils.py,sha256=w1GpdJCvt-ocwwLEaag4YVO5XH31NCvjwAGFYAiwUZE,10213
 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
@@ -22,12 +23,13 @@ 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=OHbuBP7hAFJ_ce0UAMfJ1pARMMzqvzVYiYeFMw3xZLU,3592
-enterprise_data/api/v1/serializers.py,sha256=oNLxBbHa6CJ7d7mdA0hpmLFjKMe-S6nOIguQkEu_D4Y,11723
-enterprise_data/api/v1/urls.py,sha256=wMw-h0NlkOgS1HYUm2FqGOLA-BHBdFZYaL-QNZn0T60,2635
+enterprise_data/api/v1/serializers.py,sha256=SaMFlNRMPIqaKelFZa7nYn3su7DJFS2wJfYZ5sUl_gM,12000
+enterprise_data/api/v1/urls.py,sha256=JLjkMzTiJmHtDjN5_z4hOe0s1ug8Ec3A4Ll1E5pwVmY,3206
 enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/v1/views/analytics_enrollments.py,sha256=SvuK53i_4S3etqktoJ0h5ky4dntD176u6DXZuqHTsEg,16352
 enterprise_data/api/v1/views/base.py,sha256=FTAxlz5EzvAY657wzVgzhJPFSCHHzct7IDcvm71Smt8,866
-enterprise_data/api/v1/views/enterprise_admin.py,sha256=RTSRyPfHvbzV_ihSbGjYi0VuE6AjaYZIyqpAKTMYa5Q,8980
+enterprise_data/api/v1/views/enterprise_admin.py,sha256=7f1RHlXxmH8oLr0WLxdGPNsxdhjubwyqNIefb7PMH68,9149
+enterprise_data/api/v1/views/enterprise_completions.py,sha256=LGwwCiJSBVhsm52ROIDAJQkLAaj4Wbxh-A-1INfZbOE,7433
 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
@@ -101,9 +103,10 @@ 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_enrollments.py,sha256=ApRzq6LxdAqGNNZqGoPSdLbGCf6R-z8qL8FoRf4wvvs,6712
+enterprise_data/tests/admin_analytics/mock_enrollments.py,sha256=kINSGZx7M3CcsVZ04AZAy4AqNGVbRD47OfI2_3dEVSs,7262
 enterprise_data/tests/admin_analytics/test_analytics_enrollments.py,sha256=WNdJCM52zUJikBTl3VakPIvNiVNvUed-8vk275njSdY,14847
 enterprise_data/tests/admin_analytics/test_data_loaders.py,sha256=o3denJ4aUS1pI5Crksl4C6m-NtCBm8ynoHBnLkf-v2U,4641
+enterprise_data/tests/admin_analytics/test_enterprise_completions.py,sha256=BXptZVfnTReJfMSog-ZMDnoIe6Gh_sX2GDRzyugxSMI,7356
 enterprise_data/tests/admin_analytics/test_utils.py,sha256=y33HXy6BDOoftdcz3qYlOYhgx7JSXDki-OLzBdTpiwA,11449
 enterprise_data/tests/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/tests/api/v0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -112,7 +115,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=7FCPpfFrv-pisJ9cxt3B-KIf-KM3a7XzQ8MweLp23wI,4783
+enterprise_data/tests/api/v1/views/test_enterprise_admin.py,sha256=At4g5Q4W4SNPk693HxuoEOHtMehvkscLvtXV4dbivvE,4969
 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
@@ -153,8 +156,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.6.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-8.6.0.dist-info/METADATA,sha256=UT5OiAzT8dXg3nZ9psbT8eqAbGjEnDD1GjRb8YEitv8,1569
-edx_enterprise_data-8.6.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-edx_enterprise_data-8.6.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-8.6.0.dist-info/RECORD,,
+edx_enterprise_data-8.7.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-8.7.0.dist-info/METADATA,sha256=6ZncVDwM9a49UHdde9Rk1fhjP1BEaradbGjKCHSX_WE,1569
+edx_enterprise_data-8.7.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+edx_enterprise_data-8.7.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-8.7.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.6.0"
+__version__ = "8.7.0"

enterprise_data/admin_analytics/completions_utils.py

@@ -0,0 +1,261 @@
+"""This module contains utility functions for completions analytics."""
+from enterprise_data.utils import date_filter
+
+
+def date_aggregation(level, group, date, df, type_="count"):
+    """Perform date aggregation on a DataFrame.
+
+    This function aggregates data based on the specified level of aggregation (e.g., daily, weekly, monthly, quarterly)
+    and returns the aggregated data.
+
+    Args:
+        level (str): The level of aggregation. Possible values are "Daily", "Weekly", "Monthly", and "Quarterly".
+        group (list): A list of column names to group the data by.
+        date (str): The name of the date column in the DataFrame.
+        df (pandas.DataFrame): The DataFrame containing the data to be aggregated.
+        type_ (str, optional): The type of aggregation to perform. Possible values
+            are "count" and "sum". Defaults to "count".
+
+    Returns:
+        pandas.DataFrame: The aggregated data.
+
+    """
+    if type_ == "count":
+        if level == "Daily":
+            df = df.groupby(group).size().reset_index()
+            group.append("count")
+            df.columns = group
+        elif level == "Weekly":
+            df[date] = df[date].dt.to_period("W").dt.start_time
+            df = df.groupby(group).size().reset_index()
+            group.append("count")
+            df.columns = group
+        elif level == "Monthly":
+            df[date] = df[date].dt.to_period("M").dt.start_time
+            df = df.groupby(group).size().reset_index()
+            group.append("count")
+            df.columns = group
+        elif level == "Quarterly":
+            df[date] = df[date].dt.to_period("Q").dt.start_time
+            df = df.groupby(group).size().reset_index()
+            group.append("count")
+            df.columns = group
+    elif type_ == "sum":
+        if level == "Daily":
+            df = df.groupby(group).sum().reset_index()
+            group.append("sum")
+            df.columns = group
+        elif level == "Weekly":
+            df[date] = df[date].dt.to_period("W").dt.start_time
+            df = df.groupby(group).sum().reset_index()
+            group.append("sum")
+            df.columns = group
+        elif level == "Monthly":
+            df[date] = df[date].dt.to_period("M").dt.start_time
+            df = df.groupby(group).sum().reset_index()
+            group.append("sum")
+            df.columns = group
+        elif level == "Quarterly":
+            df[date] = df[date].dt.to_period("Q").dt.start_time
+            df = df.groupby(group).sum().reset_index()
+            group.append("sum")
+            df.columns = group
+
+    return df
+
+
+def calculation(calc, df, type_="count"):
+    """Perform a calculation on the given DataFrame based on the specified calculation type.
+
+    Args:
+        calc (str): The calculation type. Possible values are "Total", "Running Total",
+                    "Moving Average (3 Period)", and "Moving Average (7 Period)".
+        df (pandas.DataFrame): The filtered enrollments data.
+        type_ (str, optional): The type of calculation to perform. Default is "count".
+
+    Returns:
+        pandas.DataFrame: The aggregated data after performing the calculation.
+    """
+    if type_ == "count":
+        if calc == "Total":
+            pass
+        elif calc == "Running Total":
+            df["count"] = df.groupby("enroll_type")["count"].cumsum()
+        elif calc == "Moving Average (3 Period)":
+            df["count"] = (
+                df.groupby("enroll_type")["count"]
+                .rolling(3)
+                .mean()
+                .droplevel(level=[0])
+            )
+        elif calc == "Moving Average (7 Period)":
+            df["count"] = (
+                df.groupby("enroll_type")["count"]
+                .rolling(7)
+                .mean()
+                .droplevel(level=[0])
+            )
+    elif type_ == "sum":
+        if calc == "Total":
+            pass
+        elif calc == "Running Total":
+            df["sum"] = df.groupby("enroll_type")["sum"].cumsum()
+        elif calc == "Moving Average (3 Period)":
+            df["sum"] = (
+                df.groupby("enroll_type")["sum"].rolling(3).mean().droplevel(level=[0])
+            )
+        elif calc == "Moving Average (7 Period)":
+            df["sum"] = (
+                df.groupby("enroll_type")["sum"].rolling(7).mean().droplevel(level=[0])
+            )
+
+    return df
+
+
+def get_completions_over_time(start_date, end_date, dff, date_agg, calc):
+    """Get agreggated data for completions over time graph.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        dff (pandas.DataFrame): enrollments data
+        date_agg (str): It denotes the granularity of the aggregated date which can be Daily, Weekly, Monthly, Quarterly
+        calc (str): Calculations denoiated the period for the running averages. It can be Total, Running Total, Moving
+            Average (3 Period), Moving Average (7 Period)
+    """
+
+    dff = dff[dff["has_passed"] == 1]
+
+    # Date filtering.
+    dff = date_filter(start=start_date, end=end_date, data_frame=dff, date_column="passed_date")
+
+    # Date aggregation.
+    dff = date_aggregation(
+        level=date_agg, group=["passed_date", "enroll_type"], date="passed_date", df=dff
+    )
+
+    # Calculating metric.
+    dff = calculation(calc=calc, df=dff)
+
+    return dff
+
+
+def get_top_courses_by_completions(start_date, end_date, dff):
+    """Get top 10 courses by completions.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        dff (pandas.DataFrame): Enrollments data
+    """
+
+    dff = dff[dff["has_passed"] == 1]
+
+    # Date filtering.
+    dff = date_filter(start=start_date, end=end_date, data_frame=dff, date_column="passed_date")
+
+    courses = list(
+        dff.groupby(["course_key"]).size().sort_values(ascending=False)[:10].index
+    )
+
+    dff = (
+        dff[dff.course_key.isin(courses)]
+        .groupby(["course_key", "course_title", "enroll_type"])
+        .size()
+        .reset_index()
+    )
+    dff.columns = ["course_key", "course_title", "enroll_type", "count"]
+
+    return dff
+
+
+def get_top_subjects_by_completions(start_date, end_date, dff):
+    """Get top 10 subjects by completions.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        dff (pandas.DataFrame): Enrollments data
+    """
+
+    dff = dff[dff["has_passed"] == 1]
+
+    # Date filtering.
+    dff = date_filter(start=start_date, end=end_date, data_frame=dff, date_column="passed_date")
+
+    subjects = list(
+        dff.groupby(["course_subject"]).size().sort_values(ascending=False)[:10].index
+    )
+
+    dff = (
+        dff[dff.course_subject.isin(subjects)]
+        .groupby(["course_subject", "enroll_type"])
+        .size()
+        .reset_index()
+    )
+    dff.columns = ["course_subject", "enroll_type", "count"]
+
+    return dff
+
+
+def get_csv_data_for_completions_over_time(
+    start_date, end_date, enrollments, date_agg, calc
+):
+    """Get csv data for completions over time graph.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        enrollments (pandas.DataFrame): Filtered enrollments data
+        date_agg (str): it denotes the granularity of the aggregated date which can be Daily, Weekly, Monthly, Quarterly
+        calc (str): calculations denoiated the period for the running averages. It can be Total, Running Total, Moving
+            Average (3 Period), Moving Average (7 Period)
+
+    Returns:
+        dict: csv data
+    """
+
+    dff = get_completions_over_time(start_date, end_date, enrollments, date_agg, calc)
+    dff = dff.pivot(index="passed_date", columns="enroll_type", values="count")
+    filename = (
+        f"Completions Timeseries, {start_date} - {end_date} ({date_agg} {calc}).csv"
+    )
+    return {"filename": filename, "data": dff}
+
+
+def get_csv_data_for_top_courses_by_completions(start_date, end_date, enrollments):
+    """Get csv data for top 10 courses by completions.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        enrollments (pandas.DataFrame): Filtered enrollments data
+
+    Returns:
+        dict: csv data
+    """
+
+    dff = get_top_courses_by_completions(start_date, end_date, enrollments)
+    dff = dff.pivot(
+        index=["course_key", "course_title"], columns="enroll_type", values="count"
+    )
+    filename = f"Top 10 Courses by Completions, {start_date} - {end_date}.csv"
+    return {"filename": filename, "data": dff}
+
+
+def get_csv_data_for_top_subjects_by_completions(start_date, end_date, enrollments):
+    """Get csv data for top 10 subjects by completions.
+
+    Args:
+        start_date (datetime): The start date for the date filter.
+        end_date (datetime): The end date for the date filter.
+        enrollments (pandas.DataFrame): Filtered enrollments data
+
+    Returns:
+        dict: csv data
+    """
+
+    dff = get_top_subjects_by_completions(start_date, end_date, enrollments)
+    dff = dff.pivot(index="course_subject", columns="enroll_type", values="count")
+    filename = f"Top 10 Subjects by Completions, {start_date} - {end_date}.csv"
+    return {"filename": filename, "data": dff}

enterprise_data/admin_analytics/utils.py

@@ -18,6 +18,9 @@ class ChartType(Enum):
     BUBBLE = 'bubble'
     TOP_SKILLS_ENROLLMENT = 'top_skills_enrollment'
     TOP_SKILLS_COMPLETION = 'top_skills_completion'
+    COMPLETIONS_OVER_TIME = 'completions_over_time'
+    TOP_COURSES_BY_COMPLETIONS = 'top_courses_by_completions'
+    TOP_SUBJECTS_BY_COMPLETIONS = 'top_subjects_by_completions'
 
 
 def granularity_aggregation(level, group, date, data_frame, aggregation_type="count"):
@@ -172,7 +175,7 @@ def get_skills_bubble_chart_df(skills_filtered):
     """ Get the skills data for the bubble chart.
 
     Args:
-        skills_filtered (list): The skills data.
+        skills_filtered (pandas.DataFrame): The skills data.
 
     Returns:
         (pandas.DataFrame): The skills data for the bubble chart.

enterprise_data/api/v1/serializers.py

@@ -206,6 +206,11 @@ class AdminAnalyticsAggregatesQueryParamsSerializer(serializers.Serializer):  #
     """
     start_date = serializers.DateField(required=False)
     end_date = serializers.DateField(required=False)
+    granularity = serializers.CharField(required=False)
+    calculation = serializers.CharField(required=False)
+    response_type = serializers.CharField(required=False)
+    page = serializers.IntegerField(required=False)
+    chart_type = serializers.CharField(required=False)
 
     def validate(self, attrs):
         """

enterprise_data/api/v1/urls.py

@@ -8,6 +8,7 @@ from rest_framework.routers import DefaultRouter
 from django.urls import re_path
 
 from enterprise_data.api.v1.views import enterprise_admin as enterprise_admin_views
+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_enrollments import (
@@ -71,6 +72,16 @@ urlpatterns = [
         enterprise_admin_views.EnterpriseAdminAnalyticsSkillsView.as_view(),
         name='enterprise-admin-analytics-skills'
     ),
+    re_path(
+        fr'^admin/anlaytics/(?P<enterprise_id>{UUID4_REGEX})/completions/stats$',
+        enterprise_completions_views.EnterrpiseAdminCompletionsStatsView.as_view(),
+        name='enterprise-admin-analytics-completions-stats'
+    ),
+    re_path(
+        fr'^admin/anlaytics/(?P<enterprise_id>{UUID4_REGEX})/completions$',
+        enterprise_completions_views.EnterrpiseAdminCompletionsView.as_view(),
+        name='enterprise-admin-analytics-completions'
+    ),
 ]
 
 urlpatterns += router.urls

enterprise_data/api/v1/views/enterprise_admin.py

@@ -189,17 +189,21 @@ class EnterpriseAdminAnalyticsSkillsView(APIView):
             data=request.GET
         )
         serializer.is_valid(raise_exception=True)
-
-        start_date = serializer.data.get("start_date")
-        end_date = serializer.data.get("end_date", datetime.now())
-
         last_updated_at = fetch_max_enrollment_datetime()
         cache_expiry = (
             last_updated_at + timedelta(days=1) if last_updated_at else datetime.now()
         )
+
+        enrollment = fetch_and_cache_enrollments_data(
+            enterprise_id, cache_expiry
+        ).copy()
+
+        start_date = serializer.data.get('start_date', enrollment.enterprise_enrollment_date.min())
+        end_date = serializer.data.get('end_date', datetime.now())
+
         skills = fetch_and_cache_skills_data(enterprise_id, cache_expiry).copy()
 
-        if request.GET.get("format") == "csv":
+        if serializer.data.get('response_type') == 'csv':
             csv_data = get_top_skills_csv_data(skills, start_date, end_date)
             response = HttpResponse(content_type='text/csv')
             filename = f"Skills by Enrollment and Completion, {start_date} - {end_date}.csv"

enterprise_data/api/v1/views/enterprise_completions.py

@@ -0,0 +1,177 @@
+"""Views for enterprise admin completions analytics."""
+import datetime
+from datetime import datetime, timedelta
+
+from edx_rbac.decorators import permission_required
+from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
+from rest_framework.response import Response
+from rest_framework.status import HTTP_200_OK
+from rest_framework.views import APIView
+
+from django.http import HttpResponse
+
+from enterprise_data.admin_analytics.completions_utils import (
+    get_completions_over_time,
+    get_csv_data_for_completions_over_time,
+    get_csv_data_for_top_courses_by_completions,
+    get_csv_data_for_top_subjects_by_completions,
+    get_top_courses_by_completions,
+    get_top_subjects_by_completions,
+)
+from enterprise_data.admin_analytics.constants import CALCULATION, GRANULARITY
+from enterprise_data.admin_analytics.data_loaders import fetch_max_enrollment_datetime
+from enterprise_data.admin_analytics.utils import ChartType, fetch_and_cache_enrollments_data
+from enterprise_data.api.v1 import serializers
+from enterprise_data.api.v1.paginators import AdvanceAnalyticsPagination
+from enterprise_data.utils import date_filter
+
+
+class EnterrpiseAdminCompletionsStatsView(APIView):
+    """
+    API for getting the enterprise admin completions.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ['get']
+
+    @permission_required(
+        "can_access_enterprise", fn=lambda request, enterprise_id: enterprise_id
+    )
+    def get(self, request, enterprise_id):
+        """
+        HTTP GET endpoint to retrieve the enterprise admin completions
+        """
+        serializer = serializers.AdminAnalyticsAggregatesQueryParamsSerializer(
+            data=request.GET
+        )
+        serializer.is_valid(raise_exception=True)
+
+        last_updated_at = fetch_max_enrollment_datetime()
+        cache_expiry = (
+            last_updated_at + timedelta(days=1) if last_updated_at else datetime.now()
+        )
+
+        enrollments = fetch_and_cache_enrollments_data(
+            enterprise_id, cache_expiry
+        ).copy()
+        # Use start and end date if provided by the client, if client has not provided then use
+        # 1. minimum enrollment date from the data as the start_date
+        # 2. today's date as the end_date
+        start_date = serializer.data.get(
+            "start_date", enrollments.enterprise_enrollment_date.min()
+        )
+        end_date = serializer.data.get("end_date", datetime.now())
+
+        if serializer.data.get('response_type') == 'csv':
+            chart_type = serializer.data.get('chart_type')
+            response = HttpResponse(content_type='text/csv')
+            csv_data = {}
+
+            if chart_type == ChartType.COMPLETIONS_OVER_TIME.value:
+                csv_data = get_csv_data_for_completions_over_time(
+                    start_date=start_date,
+                    end_date=end_date,
+                    enrollments=enrollments.copy(),
+                    date_agg=serializer.data.get('granularity', GRANULARITY.DAILY.value),
+                    calc=serializer.data.get('calculation', CALCULATION.TOTAL.value),
+                )
+            elif chart_type == ChartType.TOP_COURSES_BY_COMPLETIONS.value:
+                csv_data = get_csv_data_for_top_courses_by_completions(
+                    start_date=start_date, end_date=end_date, enrollments=enrollments.copy()
+                )
+            elif chart_type == ChartType.TOP_SUBJECTS_BY_COMPLETIONS.value:
+                csv_data = get_csv_data_for_top_subjects_by_completions(
+                    start_date=start_date, end_date=end_date, enrollments=enrollments.copy()
+                )
+            filename = csv_data['filename']
+            response['Content-Disposition'] = f'attachment; filename="{filename}"'
+            csv_data['data'].to_csv(path_or_buf=response)
+            return response
+
+        completions_over_time = get_completions_over_time(
+            start_date=start_date,
+            end_date=end_date,
+            dff=enrollments.copy(),
+            date_agg=serializer.data.get('granularity', GRANULARITY.DAILY.value),
+            calc=serializer.data.get('calculation', CALCULATION.TOTAL.value),
+        )
+        top_courses_by_completions = get_top_courses_by_completions(
+            start_date=start_date, end_date=end_date, dff=enrollments.copy()
+        )
+        top_subjects_by_completions = get_top_subjects_by_completions(
+            start_date=start_date, end_date=end_date, dff=enrollments.copy()
+        )
+
+        return Response(
+            data={
+                'completions_over_time': completions_over_time.to_dict(
+                    orient="records"
+                ),
+                'top_courses_by_completions': top_courses_by_completions.to_dict(
+                    orient="records"
+                ),
+                'top_subjects_by_completions': top_subjects_by_completions.to_dict(
+                    orient="records"
+                ),
+            },
+            status=HTTP_200_OK,
+        )
+
+
+class EnterrpiseAdminCompletionsView(APIView):
+    """
+    API for getting the enterprise admin completions.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ['get']
+    pagination_class = AdvanceAnalyticsPagination
+
+    @permission_required(
+        "can_access_enterprise", fn=lambda request, enterprise_id: enterprise_id
+    )
+    def get(self, request, enterprise_id):
+        """
+        HTTP GET endpoint to retrieve the enterprise admin completions
+        """
+        serializer = serializers.AdminAnalyticsAggregatesQueryParamsSerializer(
+            data=request.GET
+        )
+        serializer.is_valid(raise_exception=True)
+
+        last_updated_at = fetch_max_enrollment_datetime()
+        cache_expiry = (
+            last_updated_at + timedelta(days=1) if last_updated_at else datetime.now()
+        )
+
+        enrollments = fetch_and_cache_enrollments_data(
+            enterprise_id, cache_expiry
+        ).copy()
+        # Use start and end date if provided by the client, if client has not provided then use
+        # 1. minimum enrollment date from the data as the start_date
+        # 2. today's date as the end_date
+        start_date = serializer.data.get(
+            'start_date', enrollments.enterprise_enrollment_date.min()
+        )
+        end_date = serializer.data.get('end_date', datetime.now())
+
+        dff = enrollments[enrollments['has_passed'] == 1]
+
+        # Date filtering
+        dff = date_filter(start=start_date, end=end_date, data_frame=dff, date_column='passed_date')
+
+        dff = dff[['email', 'course_title', 'course_subject', 'passed_date']]
+        dff['passed_date'] = dff['passed_date'].dt.date
+        dff = dff.sort_values(by="passed_date", ascending=False).reset_index(drop=True)
+
+        if serializer.data.get('response_type') == 'csv':
+            response = HttpResponse(content_type='text/csv')
+            filename = f"Individual Completions, {start_date} - {end_date}.csv"
+            response['Content-Disposition'] = f'attachment; filename="{filename}"'
+            dff.to_csv(path_or_buf=response, index=False)
+            return response
+
+        paginator = self.pagination_class()
+        page = paginator.paginate_queryset(dff, request)
+        serialized_data = page.data.to_dict(orient='records')
+        response = paginator.get_paginated_response(serialized_data)
+
+        return response

enterprise_data/tests/admin_analytics/mock_enrollments.py

@@ -3,6 +3,7 @@
 import pandas as pd
 
 from enterprise_data.admin_analytics.constants import ENROLLMENT_CSV
+from enterprise_data.admin_analytics.utils import ChartType
 
 ENROLLMENTS = [
     {
@@ -71,7 +72,7 @@ ENROLLMENTS = [
         "cert_awarded": 0,
         "date_certificate_created_raw": None,
         "passed_date_raw": None,
-        "passed_date": None,
+        "passed_date": '2022-08-24',
         "has_passed": 0,
     },
     {
@@ -94,7 +95,7 @@ ENROLLMENTS = [
         "cert_awarded": 0,
         "date_certificate_created_raw": None,
         "passed_date_raw": None,
-        "passed_date": None,
+        "passed_date": "2022-08-24",
         "has_passed": 0,
     },
     {
@@ -117,7 +118,7 @@ ENROLLMENTS = [
         "cert_awarded": 0,
         "date_certificate_created_raw": None,
         "passed_date_raw": None,
-        "passed_date": None,
+        "passed_date": "2022-08-20",
         "has_passed": 0,
     },
 ]
@@ -142,6 +143,21 @@ ENROLLMENT_STATS_CSVS = {
         b'course_subject,certificate\nbusiness-management,2\ncommunication,1\nmedicine,1\nsocial-sciences,1\n'
     )
 }
+COMPLETIONS_STATS_CSVS = {
+    ChartType.COMPLETIONS_OVER_TIME.value: (
+        b'passed_date,certificate\n'
+        b'2021-08-25,1\n'
+        b'2021-09-01,2\n'
+    ),
+    ChartType.TOP_COURSES_BY_COMPLETIONS.value: (
+        b'course_key,course_title,certificate\n'
+        b'hEmW+tvk03,Re-engineered tangible approach,2\n'
+    ),
+    ChartType.TOP_SUBJECTS_BY_COMPLETIONS.value: (
+        b'course_subject,certificate\n'
+        b'business-management,2\n'
+    )
+}
 
 
 def enrollments_dataframe():

enterprise_data/tests/admin_analytics/test_enterprise_completions.py

@@ -0,0 +1,202 @@
+"""Unitest for EnterpriseAdminCompletionsStatsView."""
+from datetime import datetime
+
+import ddt
+from mock import patch
+from rest_framework import status
+from rest_framework.reverse import reverse
+from rest_framework.test import APITransactionTestCase
+
+from enterprise_data.admin_analytics.utils import ChartType
+from enterprise_data.tests.admin_analytics.mock_enrollments import (
+    COMPLETIONS_STATS_CSVS,
+    ENROLLMENTS,
+    enrollments_dataframe,
+)
+from enterprise_data.tests.mixins import JWTTestMixin
+from enterprise_data.tests.test_utils import UserFactory
+from enterprise_data_roles.constants import ENTERPRISE_DATA_ADMIN_ROLE
+from enterprise_data_roles.models import EnterpriseDataFeatureRole, EnterpriseDataRoleAssignment
+
+
+@ddt.ddt
+class TestCompletionstStatsAPI(JWTTestMixin, APITransactionTestCase):
+    """Tests for EnterrpiseAdminCompletionsStatsView."""
+
+    def setUp(self):
+        """
+        Setup method.
+        """
+        super().setUp()
+        self.user = UserFactory(is_staff=True)
+        role, __ = EnterpriseDataFeatureRole.objects.get_or_create(
+            name=ENTERPRISE_DATA_ADMIN_ROLE
+        )
+        self.role_assignment = EnterpriseDataRoleAssignment.objects.create(
+            role=role, user=self.user
+        )
+        self.client.force_authenticate(user=self.user)
+
+        self.enterprise_id = "ee5e6b3a-069a-4947-bb8d-d2dbc323396c"
+        self.set_jwt_cookie()
+
+        self.url = reverse(
+            "v1:enterprise-admin-analytics-completions-stats",
+            kwargs={"enterprise_id": self.enterprise_id},
+        )
+
+        fetch_max_enrollment_datetime_patcher = patch(
+            'enterprise_data.api.v1.views.enterprise_completions.fetch_max_enrollment_datetime',
+            return_value=datetime.now()
+        )
+
+        fetch_max_enrollment_datetime_patcher.start()
+        self.addCleanup(fetch_max_enrollment_datetime_patcher.stop)
+
+    @patch(
+        "enterprise_data.api.v1.views.enterprise_completions.fetch_and_cache_enrollments_data"
+    )
+    def test_get(self, mock_fetch_and_cache_enrollments_data):
+        """
+        Test the GET method for the EnterrpiseAdminCompletionsStatsView works.
+        """
+        mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
+
+        params = {
+            "start_date": "2020-01-01",
+            "end_date": "2025-08-09",
+            "calculation": "Running Total",
+            "granularity": "Daily",
+        }
+        response = self.client.get(self.url, params)
+        assert response.status_code == status.HTTP_200_OK
+        data = response.json()
+        assert data == {
+            "completions_over_time": [
+                {
+                    "passed_date": "2021-08-25T00:00:00",
+                    "enroll_type": "certificate",
+                    "count": 1,
+                },
+                {
+                    "passed_date": "2021-09-01T00:00:00",
+                    "enroll_type": "certificate",
+                    "count": 2,
+                },
+            ],
+            "top_courses_by_completions": [
+                {
+                    "course_key": "hEmW+tvk03",
+                    "course_title": "Re-engineered tangible approach",
+                    "enroll_type": "certificate",
+                    "count": 2,
+                }
+            ],
+            "top_subjects_by_completions": [
+                {
+                    "course_subject": "business-management",
+                    "enroll_type": "certificate",
+                    "count": 2,
+                }
+            ],
+        }
+
+    @patch("enterprise_data.api.v1.views.enterprise_completions.fetch_and_cache_enrollments_data")
+    @ddt.data(
+        ChartType.COMPLETIONS_OVER_TIME.value,
+        ChartType.TOP_COURSES_BY_COMPLETIONS.value,
+        ChartType.TOP_SUBJECTS_BY_COMPLETIONS.value,
+    )
+    def test_get_csv(self, chart_type, mock_fetch_and_cache_enrollments_data):
+        """
+        Test that EnterrpiseAdminCompletionsStatsView return correct CSV data.
+        """
+        mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
+        params = {
+            'start_date': '2020-01-01',
+            'end_date': '2025-08-09',
+            'calculation': 'Running Total',
+            'granularity': 'Daily',
+            'response_type': 'csv',
+            'chart_type': chart_type,
+        }
+        response = self.client.get(self.url, params)
+        assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "text/csv"
+        # verify the response content
+        assert response.content == COMPLETIONS_STATS_CSVS[chart_type]
+
+
+@ddt.ddt
+class TestCompletionstAPI(JWTTestMixin, APITransactionTestCase):
+    """Tests for EnterrpiseAdminCompletionsView."""
+
+    def setUp(self):
+        """
+        Setup method.
+        """
+        super().setUp()
+        self.user = UserFactory(is_staff=True)
+        role, __ = EnterpriseDataFeatureRole.objects.get_or_create(
+            name=ENTERPRISE_DATA_ADMIN_ROLE
+        )
+        self.role_assignment = EnterpriseDataRoleAssignment.objects.create(
+            role=role, user=self.user
+        )
+        self.client.force_authenticate(user=self.user)
+
+        self.enterprise_id = "ee5e6b3a-069a-4947-bb8d-d2dbc323396c"
+        self.set_jwt_cookie()
+
+        self.url = reverse(
+            "v1:enterprise-admin-analytics-completions",
+            kwargs={"enterprise_id": self.enterprise_id},
+        )
+
+        fetch_max_enrollment_datetime_patcher = patch(
+            'enterprise_data.api.v1.views.enterprise_completions.fetch_max_enrollment_datetime',
+            return_value=datetime.now()
+        )
+
+        fetch_max_enrollment_datetime_patcher.start()
+        self.addCleanup(fetch_max_enrollment_datetime_patcher.stop)
+
+    def verify_enrollment_data(self, results, results_count):
+        """Verify the received enrollment data."""
+        attrs = [
+            "email",
+            "course_title",
+            "course_subject",
+            "passed_date",
+        ]
+
+        assert len(results) == results_count
+
+        filtered_data = []
+        for enrollment in ENROLLMENTS:
+            for result in results:
+                if enrollment["email"] == result["email"]:
+                    filtered_data.append({attr: enrollment[attr] for attr in attrs})
+                    break
+        received_data = sorted(results, key=lambda x: x["email"])
+        expected_data = sorted(filtered_data, key=lambda x: x["email"])
+        assert received_data == expected_data
+
+    @patch(
+        "enterprise_data.api.v1.views.enterprise_completions.fetch_and_cache_enrollments_data"
+    )
+    def test_get(self, mock_fetch_and_cache_enrollments_data):
+        """
+        Test the GET method for the EnterrpiseAdminCompletionsView works.
+        """
+        mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
+
+        response = self.client.get(self.url, {"page": 1, "page_size": 1})
+        assert response.status_code == status.HTTP_200_OK
+        data = response.json()
+        assert data["next"] == f"http://testserver{self.url}?page=2&page_size=1"
+        assert data["previous"] is None
+        assert data["current_page"] == 1
+        assert data["num_pages"] == 2
+        assert data["count"] == 2
+        self.verify_enrollment_data(data["results"], 1)

enterprise_data/tests/api/v1/views/test_enterprise_admin.py

@@ -108,6 +108,10 @@ class TestEnterpriseAdminAnalyticsSkillsView(JWTTestMixin, APITransactionTestCas
             return [
                 list(item.values()) for item in get_dummy_skills_data(self.enterprise_id)
             ]
+        elif 'fact_enrollment_admin_dash' in query:
+            return [
+                list(item.values()) for item in get_dummy_enrollments_data(self.enterprise_id, 15)
+            ]
         else:
             return [
                 list(item.values()) for item in get_dummy_skills_data(self.enterprise_id)