Change Log ========== Below are the list of additions, changes and deprecations since 2022-05-01. If you wish to subscribe to our email, `please sign up here`_. .. _please sign up here: http://eepurl.com/h1eEdL .. contents:: List of changes :depth: 1 :backlinks: entry :local: ------------------------------ 2024-06-24 - Account Filtering ------------------------------ ^^^^^^^^^ Additions ^^^^^^^^^ - Added ability to use the API for a subaccount of the token's associated account. See :ref:`Subaccount Dashboards ` and :doc:`v2/account_filtering` sections for more information. -------------------------- 2024-04-12 - How-to Guides -------------------------- ^^^^^^^^^ Additions ^^^^^^^^^ - Documentation change only. Added :doc:`v2/how-to` section that provides various examples of integrating with the API using Python. -------------------------------------- 2023-08-25 - Dashboard Upload warnings -------------------------------------- ^^^^^^^^^ Additions ^^^^^^^^^ - Documentation change only. Clarified the scenario of using the API to replace existing dashboards and the impact on Dropout Detective / Grade Guardian access managers. --------------------------------------- 2022-12-20 - Dropout Detective overview --------------------------------------- ^^^^^^^^^ Additions ^^^^^^^^^ - Added Dropout Detective section with information about the web application to help technology teams who are integrating with the API. This has zero functional changes to the API. - Added Testing section to let technology teams know we can create a sandbox for them. ^^^^^^^^^ Changes ^^^^^^^^^ - Fixed reference to ``error`` and ``missing`` properties in the Dashboard Upload response ``status`` property description. Previously mentioned the additional information was in the ``results`` property. - Improved information on ``clear_existing_policy`` in the Dashboard Upload POST documentation. ------------------------------ 2022-09-21 - Dashboard Viewers ------------------------------ ^^^^^^^^^ Changes ^^^^^^^^^ - Corrected documentation on Dashboard Viewers page to use "Viewer" as the name of the property table. It was previously using "Student". ----------------------------- 2022-08-10 - Advisors retired ----------------------------- ^^^^^^^^^ Changes ^^^^^^^^^ - All functionality related to advisors has been retired. Please use Dashboards. ------------------------------------ 2022-08-08 - Dashboard Uploads - Web ------------------------------------ ^^^^^^^^^ Changes ^^^^^^^^^ - Dashboard uploads created via the web use the v2 of the API and will be present in the API responses. This only impacts uploads that were created from 2022-08-08 and beyond. --------------------------------------------------- 2022-07-06 - Dashboard Uploads - ``viewer_is_ally`` --------------------------------------------------- ^^^^^^^^^ Changes ^^^^^^^^^ - Corrected the documentation to list ``viewer_is_ally`` as the name of the property to be used when uploading dashboard viewers. It was previously listed as ``is_ally``. - Corrected the ``data_type`` values (``"student"`` and ``"viewer"``) in example responses to be singular case. ------------------------------ 2022-07-01 - Dashboard Uploads ------------------------------ ^^^^^^^^^ Additions ^^^^^^^^^ - Added a more robust way to control the students and viewers of Dashboard. The ``clear_existing_policy`` option now allows clearing only the dashboards that are specified in the uploads. See :doc:`v2/dashboard_uploads` ------------------------------------------ 2022-06-08 - Dashboard Unassigned Students ------------------------------------------ ^^^^^^^^^ Additions ^^^^^^^^^ - :doc:`v2/dashboard_unassigned_students` -------------------------------- 2022-05-02 - Added API Version 2 -------------------------------- ^^^^^^^^^ Additions ^^^^^^^^^ Added Version 2 of the API. Includes support for the following API endpoints. - Dashboards - list, create, update, delete - Dashboard students - list - Dashboard viewers - list