Reports API Release Log Overview
Below is an overview of notes for each release of Reports API.
Versions on this page
- Latest
- 2019.2.LTS Recommended (Rel.: 26th June 2019, EoL: 26th June 2021)
- 2019.1.LTS (Rel.: 27th February 2019, EoL: 28th February 2021)
- 2018.2.LTS (Rel.: 3rd October 2018, EoL: 30th September 2020)
- 2018.1.LTS (Rel.: 6th June 2018, EoL: 31st May 2020)
Latest
Our rolling release. This release contains in-development new features released since the most recent Long Term Support.
This should only be used for in-development systems targeting a production release using the next Long Term Support release (see our Learnosity Help article for further details) or for testing upcoming features while in-development.
Features
Reports API v1.14.0
- Added a new options key to the Questions array that the
response-analysis-by-itemreport returns for the MCQ type (multiple choice) Question. This enables theresponse-analysis-by-itemreport to display Questions in the same order as in the Question Editor API.
Bugfixes
Reports API v1.14.0
- Fixed a bug in
session-detail-by-itemreports, where Sessions initialised with duplicate Items could not be rendered. - Fixed a bug in the
item-scores-by-tag-by-userreport, where the tooltips ran off the screen, due to long text in the column.
Features
Reports API v1.13.0
- Added support for specifying
organisation_idin the following reports:event-progress-by-tag-by-user,last-score-by-tag-by-user,progress-by-tagprogress-by-tag-by-userprogress-singleandsessions-summary-by-tag. This allows an API Consumer to report on sessions using Items and Tag hierarchies from one of its additional Item banks, if available.
Bugfixes
Reports API v1.13.0
- Fixed a bug in
item-scores-by-tag-by-userreport where the background image was not displayed.
Bugfixes
Reports API v1.12.3
- Fixed a bug in
item-scores-by-tag-by-userwhere users were not displayed in the same order as in the initialisation options. - Fixed a bug in
session-detail-by-itemwhere usingquestions_api_init_options.labelBundlewould return an error stating the option was not allowed.
Bugfixes
Reports API v1.12.2
- Fixed a bug in existing reports that have screen-readable score chart content, where screen readers would read out multiple lines of text at once without pause, as if there was no punctuation. This resulted in garbled and confusing descriptions of score portions. Now, screen readers will pause at appropriate times when reading multiple lines of content to describe score charts.
Bugfixes
Reports API v1.12.1
- Fixed a bug in
session-detail-by-itemreports where Sessions initialised with Item objects (including Activity templates from Author API v2018.2.LTS or later) could not be rendered.
Features
Reports API v1.12.0
- Added the ability to navigate clickable links (that are enabled with click events) via keyboard controls, to allow keyboard-only users to access the links. See here for the full list of affected report types and event types.
Bugfixes
Reports API v1.12.0
- Fixed a bug in the
item-scores-by-tag-by-userreport where some drill-down requests would be slow to respond, or result in a 500 error.
Polish
Reports API v1.12.0
- Improved JS canvas-based score bars accessibility across all UI report types (except
sessions-list-by-item,session-detail-by-item,session-detail-by-question,last-score-by-item-by-user,live-activity-status-by-user,activity-summary-by-group,sessions-summary-by-groupanditem-scores-by-tag-by-user),- Correcting score element order in score bar
- Supporting screen reader to read the content of the score bar.
Features
Reports API v1.11.0
- Improved keyboard and content accessibility of chart tooltips across all UI report types (except
item-scores-by-tag-by-user,sessions-summary-by-groupandactivity-summary-by-group), in accordance with WCAG 2.1 guidelines:- It is now possible to toggle chart tooltips using keyboard focus. This allows keyboard-only users to view the contents of the tooltips. Additionally, tooltips can now be read by screen readers.
- Tooltips will now remain visible if the cursor is positioned onto the tooltip. This allows the text inside the tooltip to be selected using the cursor.
- All visible chart tooltips can now be dismissed by pressing the Escape character key.
- Added the ability to expand and collapse accordions in
sessions-summary-by-tagreport andprogress-by-tagreport using only keyboard controls. This ensures that both reports meet WCAG 2.1 Level A in keyboard accessibility.
Bugfixes
Reports API v1.11.0
- Fixed a bug in the
session-detail-by-itemreport andsession-detail-by-questionreport, where the tooltips on the score bubbles could be partially obscured and were visually inconsistent with other report types. They now have consistent styling and are displayed to the left of the score bubble for better usability. - Fixed a bug when rendering two
item-scores-by-tag-by-userreports, where one report would display the previous report’s values instead of its own if they had the same user IDs. - Fixed a bug where sessions saved via Data API's
SET /sessionsendpoint in the format:from_templatedid not work with some reports.
Polish
Reports API v1.11.0
- Updated the placement of chart tooltips on some reports, for better usability.
2019.2.LTS Recommended
This provides a stable, supported codebase, receiving stability & performance code fixes for its full lifecycle.
This is our recommended version for production releases right now.
Read more about 2019.2.LTS here.
- Released: 26th June 2019
- End of Life: 26th June 2021
Bugfixes
Reports API v1.10.5
- Fixed a bug in
session-detail-by-itemreports, where Sessions initialised with duplicate Items could not be rendered. - Fixed a bug in the
item-scores-by-tag-by-userreport, where users are not displayed in the same order as in the initialization options array. - Fixed a bug in the
item-scores-by-tag-by-userreport, where the tooltips ran off the screen, due to long text in the column.
Bugfixes
Reports API v1.10.4
- Fixed a bug in
session-detail-by-itemwhere usingquestions_api_init_options.labelBundlewould return an error stating the option was not allowed.
Bugfixes
Reports API v1.10.3
- Fixed a bug in
session-detail-by-itemreports where Sessions initialised with Item objects (including Activity templates from Author API v2018.2.LTS or later) could not be rendered.
Bugfixes
Reports API v1.10.2
- Fixed a bug when rendering two
item-scores-by-tag-by-userreports, where one report would display the previous report’s values instead of its own if they had the same user IDs.
Bugfixes
Reports API v1.10.1
- Fixed a bug where sessions saved via Data API's
SET /sessionsendpoint in the format:from_templatedid not work with some reports.
Features
Reports API v1.10.0
- session-detail-by-item report: Added support for passing the
items_api_init_options.config.option. This enables more control over how the session is shown by Reports API, eg. set
ignore_question_attributes"shuffle_options": falseso that MCQ options are consistently displayed in their default order to make review easier.
Bugfixes
Reports API v1.10.0
- Fixed a bug where the
getData()method would be broken if the subsequent requested user_ids with a different combination of user_id. - Fixed a bug in the
response-analysis-by-itemreport where the report silently failed with an invalid session. The report is now giving an error message explaining why the session can't be processed. - Fixed a bug with label bundles where the
not_attemptedandnot_markedaliases were not working as documented.
Polish
Reports API v1.9.1
- Improved error messages and validation when too many entries are passed in arrays of activities, sessions or users.
Features
Reports API v1.9.0
- Added new report type
response-analysis-by-item, a report for retrieving and comparing individual responses for a class of students. This report is UI-less, but can be used to build a custom report view. - Added new
getData()public method for theitem-scores-by-tag-by-userreport. This method allows retrieving the same raw score data that is available in the user interface of the report.
Features
Reports API v1.8.0
- Added support for showing new versions of report datasets. This feature is used via the Data API's SET
/reports/datasetsendpoint.
2019.1.LTS
This provides a stable, supported codebase, receiving stability & performance code fixes for its full lifecycle.
Read more about 2019.1.LTS here.
- Released: 27th February 2019
- End of Life: 28th February 2021
Bugfixes
Reports API v1.7.5
- Fixed a bug in the
item-scores-by-tag-by-userreport, where the tooltips ran off the screen, due to long text in the column.
Bugfixes
Reports API v1.7.4
- Fixed a bug when rendering two
item-scores-by-tag-by-userreports, where one report would display the previous report’s values instead of its own if they had the same user IDs.
Bugfixes
Reports API v1.7.3
- Fixed a bug in the
Item Scores by Tag by Userreport where the drill down functionality did not work if the report was displaying exactly one column.
Refactors
Reports API v1.7.2
- Various internal changes that improve stability.
Features
Reports API v1.7.1
- Internal performance improvements for executing requests with Learnosity servers.
Features
Reports API v1.7.0
- Added new
student rollupview to theitem-scores-by-tag-by-userreport, which is shown when the now optionalrow_tag_typeis omitted. It shows only the student rows, with scores aggregated according to the content hierarchy.
Bugfixes
Reports API v1.7.0
- Fixed a bug in the
Session Detail By Itemand theSession Detail By Questionreports, where styles from the report page could affect the styling of the Items. Now styles of the stimulus and other Question elements created via Author Site / Author API will be displayed correctly.
2018.2.LTS
This provides a stable, supported codebase, receiving stability & performance code fixes for its full lifecycle.
Read more about 2018.2.LTS here.
- Released: 3rd October 2018
- End of Life: 30th September 2020
The 2018.2.LTS version is identical to the previous version.
2018.1.LTS
Our first Long Term Support release. This provides a stable, supported codebase, receiving stability & performance code fixes for its full lifecycle.
Note that v2018.2.LTS is now available, so we recommend using that version for production releases instead now.
Read more about 2018.1.LTS here.
- Released: 6th June 2018
- End of Life: 31st May 2020
Features
Reports API v1.6.3
- Internal performance improvements for executing requests with Learnosity servers.
Bugfixes
Reports API v1.6.2
- Fixed a bug in
item-scores-by-tag-by-userreport with scrolling performance on mobile devices.
Bugfixes
Reports API v1.6.1
- Fixed the way cross-domain iframe is served, it is now using requested version by server side determination. This allows better forward compatibility.
Features
Reports API v1.6.0
- Added support for LTS versions
- v2018.1.LTS is released
For information on releases prior to 6th June 2018, please click here.