change.data - Events - Reports API

Reports API Events

change:data

Fires when users take an action that causes the report to pull new information when using the Sessions Summary by Group or Activity Summary by Group reports.

You would want to be notified about this event firing to take some action when the report data has changed or reloaded, for example.

More specifically, this event fires after the data for a new group_path is loaded, in response to user navigation or a call to the viewGroup() method.

Examples

reportsApp.report('my-large-group-report-id').on('change:data', function (reportData) {
      console.log('This code executes when an audio player has stopped or completed playback.');
  });

Callback arguments

  • reportData object

    The group hierarchy information for this specific group path. The object structure is equivalent to that available via the getGroup() method.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.