This article contains a list of coming-soon changes to the QA platform. Specifically, this article lists the changes that could affect code you have written using our API or automations that you have set up with our reports.

July 2023

We are replacing three reports with new versions:

• The current Content Progress report returns two reports: Product Progress report and course Progress report. After this change, you can run the replacement reports individually.
• The current User Usage report available to run in the platform interface is being replaced by the Member Activity report. The current report has three corresponding API endpoints to control the scope of the report. All three endpoints will be replaced by a single endpoint.

Product Progress report being replaced by new Content Progress report

Product Progress report is being replaced by Content Progress report. Where you currently use this API endpoint:

/v1/reports/consumption-content/

Use this endpoint instead:

/v1/reports/content-progress/

course Progress report being replaced with new version

course Progress report is being replaced by a new version with the same name: course Progress report. Where you currently use this API endpoint: 

/v1/reports/consumption-learning-paths/

Use this endpoint instead:

/v1/reports/lp-progress-export/

Usage Report being replaced by Member Activity report

The Usage report is being replaced by the Member Activity Report. Where you currently use any of the following three API endpoints:

/v1/reports/company-usage/

/v1/reports/team-usage/

/v1/reports/user-usage/

Use this endpoint instead:

/v1/reports/user-activity/

You have the option to specify the start and end date of data to include in the report with this endpoint. You also have the option to specify one or more team IDs and member IDs. See the API documentation in Swagger for more details.

10 August 2023

Deprecating the /v1/company/library/ API endpoint

On 10 August 2023, the following API endpoint will be deprecated:

/v1/company/library/

This functionality of this endpoint has been replaced by the following:

/v1/content/catalog/

If you use the endpoint that is going to be deprecated, you should plan update your code to use the replacement endpoint as soon as possible. If you are still using the outdated endpoint, you will receive further communication from your CSM as the deprecation date approaches.

Past Bulletins

15 October 2022

Enterprise Bridge Function Endpoint Changing

Currently, the enterprise bridge function endpoint is remote-desktop.srv.cloudacademy.com.

Effective October 15, 2022 the endpoint will change to remote-desktop.cloudacademy.com. We recommend that your IT department add the new endpoint to the allowed list immediately to prevent any service interruptions.

13 June 2022

Changing report filenames, names, and scope

On 13 June, you will see the following changes to reports:

• The scope of the Active Team Members report will be expanded to include invited users in addition to users who have accepted their invitation. The name of the report will change to Team Members report, and the filename you download will be team_members_YYYY-MM-DD--HH-MM-SS.zip
• For consistency, the name of the Active and Invited Members report will change to Members report. The filename you download will be members_YYYY-MM-DD--HH-MM-SS.zip.

9 May 2022

New Fields on Four Reports

We're adding the following two new fields:

• Job Role: Contains the title of the job role assigned to the team member identified in the User Id field. This field is blank if the member is not assigned a job role.
• Career Path: Contains the title of the career path that contains the job role identified in the Job Role field. This field is blank if the member is not assigned a job role or if the assigned job role is not part of a career path.

The fields will appear at the end of the following four reports:

• Active Team Members report
• Active and Invited Members report
• User Skills report
• Certification report

The fields are scheduled to be added to the reports during the week of 9 May 2022. 

Additionally, two more fields are also planned to be added to the Active and Invited Team Members report that week:

• Current license expiry date: Contains the date the member's active content-access license is set to expire. This column is blank if the member does not have a current active content-access license.
• Previous license expiry date: Contains the date the member's most recently expired content access license expired. This column is blank if the member does not have a previously expired content-access license.

New Fields for the Progress Endpoint Payloads

We are adding two new fields to the payloads for the following API endpoints:

• /v2/user/progress/

• /v2/user/{user_id}/progress/

These two fields will appear in the payload in addition to the fields that you are already accustomed to. Nothing is being removed or changed.

The two new fields are:

• last_success_rate: This field contains the success rate the user achieved in their last session. A value appears in this field for quizzes, exams, hands-on labs, and lab challenges:

  • For quizzes and exams, this field contains the percentage of questions the user answered correctly.
  • For hands-on labs and lab challenges, this field contains 100 if the user successfully completed the lab or 0 if they did not.

• is_passed_once: This field is true if the user ever passed quiz, exam, hands-on lab, or lab challenge at least once.

These fields are available only through the API. They will be added to reports at a later date. 

1 February 2022

Effective February 1, 2022, the following two reports will have new names:

• The Members Report will be called the Active and Invited Members report. The file you receive when you run this report will have the following filename:

  active_and_invited_members_YYYY-MM-DD--HH-MM-SS.zip

• The Team Membership report will now be called the Active Team Members report. The file you receive when you run this report will have the following filename:

  active_team_members_YYYY-MM-DD--HH-MM-SS.zip

The content of these reports will remain the same, and nothing will change about the API calls you use to generate these reports. Only the names and filenames are changing. See New Titles for Two Reports for full information.

31 January 2022

Update your SSO Configuration

QA and QA are in the process of changing our authentication provider, which will require accounts currently using SSO to update their SSO configuration. If you started your enterprise account subscription before October 2021 and have not already updated your configuration, you must complete this process by January 31, 2022.

See How the New SSO Configuration Is Different for instructions or contact your CSM for more information.

10 January 2022

Removing Training Plan Consumption Report API Endpoint

The following API endpoint was deprecated in October 2021 and will be removed on January 10, 2022:

/v1/reports/consumption-training-plans/

Calling this endpoint triggered the generation of a deprecated version of the Training Plan Consumption report, which is no longer supported.

You must update any automations to call the following endpoint instead: 

/v1/reports/training-plan-progress/

Calling this endpoint triggers the generation of the supported Training Plan Progress Report. You must make this change before January 10, 2022 to avoid a disruption in your reporting process.

10 November 2021

Addition to course Content Report

The course Content report will have a new columns called course Identifier appended to the end. This column contains a universally unique identifier for the course.

There are no current plans to deprecate the existing course Id column in this report; however, you should use this column instead of the course Id column in your automations. 

Addition to Training Plan Content Report

The Training Plan Content Report will have a new column called Step Content Identifier appended to the end. This column contains a universally unique identifier for the content in this step of the training plan.

There are no current plans to deprecate the existing Step Content Id column in this report; however, you should use this column instead of the Step Content Id column in your automations. 

31 October 2021

The following changes will occur on October 31, 2021. You should prepare for these changes by updating any reporting dependencies or integrations accordingly. 

Changes to Reports

Members Report - Legacy will be removed from the Reports screen in the platform on October 31, 2021. You should update any dependencies to use the Members Report instead.

Changes to Reports APIs

Members: The following report endpoint will no longer be available after October 31, 2021:

/members 

You should update any integrations to call the following endpoints instead:

/members_export 

/content_access_report 

 

Training Plans: The following report endpoint will no longer be available after October 31, 2021

/training_plan_consumption

You should update any integrations to call the following endpoint instead:

/training_plan_progress 

 

Changes to LMS APIs

The following endpoints now have a version 2 available. The new endpoint documentation is available here. You should update your integrations to call the /v2 endpoints before October 31, 2021. On October 31, 2021, /v1 endpoints will stop working.

• /company/progress

  • V2 removes the pagination and instead returns a full list of company members in one payload.
  • V2 uses an alpha-numerical identifier for members in the URL returned for each one as opposed to a numerical identifier.

• /user/{user_id}/progress
  

  • V2 removes the pagination and instead returns a full list of user activities in one payload.
  • The following fields have been removed: entity_short_description, entity_description, object_id
  • Progress is a single field, as opposed to three separate fields (progress_completeness, progress_coverage, progress_successful)
  • The provided user ID must be the alpha-numeric version as opposed to a numeric ID.

• /user/progress

  • No user-facing change.