Export Dashboard to Scheduled Reports by chippison · Pull Request #24019 · matomo-org/matomo

chippison · 2026-01-28T00:57:48Z

Description

DEV-19806

We want to add in a functionality to export the current dashboard into a Scheduled Report. This will attempt to map dashboard widgets with reports available to be scheduled.

This will not be a perfect 1-1 relationship between dashboard widget and scheduled reports and there will be some widgets that will not be mapped to a report. The user will be informed/notified about the missing dashboard widgets in an infoobox that will show everytime we export a dashboard.

This will cover 3 JIRA issues:
https://innocraft.atlassian.net/browse/DEV-19804
https://innocraft.atlassian.net/browse/DEV-19805
https://innocraft.atlassian.net/browse/DEV-19806

Acceptance Criteria:

A new link is added under the Dashboard selector menu, in the section “Manage this dashboard”
- The link label is: “Export this dashboard”
- The link is positioned as the first item in the section, above “Reset dashboard”
- The link is visible to all users, including:
  - View users
  - Users without write permissions
  - Anonymous users (eg. demo environments)
Clicking the link
- Works for authenticated users with at least View access
- Redirects unauthenticated users to the login flow as per existing behaviour
Clicking “Export this dashboard” redirects the user to Create and Schedule a report
Matomo (in the Dashboard plugin controller) will automatically map:
- Dashboard widgets → report list.
Widgets without a corresponding report are excluded from the export configuration
- Example: “About Matomo” widgets
When the user lands on the Create and Schedule a report page via this dashboard link:
- A new info box is displayed at the top of the page
- This info box is only shown when coming from a dashboard export action
- Proposed text in the JIRA issue DEV-19806
Report configuration defaults
- Report description
  - Automatically pre-filled
  - Editable by the user
  - Proposed text in the JIRA issue DEV-19806
- Report selection
  - All reports that match widgets from the dashboard are pre-selected
  - Reports that do not match a widget remain unselected

Checklist

[✔] I have understood, reviewed, and tested all AI outputs before use
[✔] All AI instructions respect security, IP, and privacy rules

Review

chippison · 2026-01-28T20:41:07Z

plugins/Dashboard/vue/src/DashboardSettings/DashboardSettings.vue

+        ...MatomoUrl.urlParsed.value,
+      } as QueryParameters;
+
+      delete query.category;


This is just to clear off unrelated parameters in the URL and hash

chippison · 2026-01-29T00:08:11Z

plugins/Dashboard/vue/src/DashboardSettings/DashboardSettings.vue

+
+      hash.idDashboard = dashboardId;
+      delete hash.category;
+      delete hash.subcategory;


…not logged in

…mDimensions

…unning/calling multiple functions to get report index

…nstead of json of its widgets. We will just make an ajax request to grab needed data on ManageScheduledReport.vue

…and we only call this when dashboardId is present in the URL

…of it being done on the index action of controller

…h unmapped widgets

…ses yet

…t follow our default pattern

…e sure we return an array with complete keys

…r the refresh instead of before so that we can clearly see the notification for save and update

…if the Ajax call is rejected or errors out

… get dashboard id

…name or export mapping is empty

…we don't get issues with repeated auto-export when the parameter is in the hash

…ameters for getWidgetReportMap function

…ng of the wrong dashboard

…iew.php) so that we do not need to hardcode 'Login' when trying to get login module

…om URL so that it we do not re-export the dashboard when the page is refreshed

…are matched independently

…ished in our api listing

chippison added this to the 5.7.0 milestone Jan 28, 2026

chippison force-pushed the dev-19806 branch from 17a5cc4 to fc83902 Compare January 28, 2026 01:03

chippison commented Jan 28, 2026

View reviewed changes

chippison modified the milestones: 5.7.0, 5.8.0 Jan 29, 2026

chippison commented Jan 29, 2026

View reviewed changes

chippison marked this pull request as ready for review January 29, 2026 00:37

chippison requested a review from a team January 29, 2026 00:37

chippison force-pushed the dev-19806 branch 4 times, most recently from fe3958b to d9a9b52 Compare February 16, 2026 01:20

chippison and others added 18 commits February 20, 2026 08:17

adding link to export dashboard

dca4ac2

rebase branch with 5.x-dev

5fec93e

grabbing dashboard widgets as well as redirecting to login page when …

83e0095

…not logged in

rebasing

b05e5d1

making widget report mapper be able to handle CustomReports and Custo…

13e22d3

…mDimensions

refactoring widget mapper so that we use only 1 function instead of r…

56d8941

…unning/calling multiple functions to get report index

refactoring so that we only pass in dashboardId to ScheduledReports i…

0226d26

…nstead of json of its widgets. We will just make an ajax request to grab needed data on ManageScheduledReport.vue

adding in new API so that we can grab widget-report mapping via AJAX …

5981381

…and we only call this when dashboardId is present in the URL

cleaning up code since we are using AJAX to grab the mapping instead …

1fc4a0a

…of it being done on the index action of controller

Build vue files

ce76c78

removed unused files

946dd38

showing info message enumerating the widgets that are not mapped

4db64a6

adding built files and an integration test to test report mapping wit…

242b798

…h unmapped widgets

removing manual overrides for now, since we don't have any special ca…

c913e99

…ses yet

adding new mapping function for edge case widgets-reports which do no…

f858f5e

…t follow our default pattern

adding new mapping function for getting event widgets

dd4d77d

adding the dashboard name to the returned values from the API

214eaf5

adding infobox to inform the user about the exported dashboard

1665a91

innocraft-automation and others added 27 commits February 20, 2026 08:17

Build vue files

6feebff

fixing issue with loader not disappearing after loading the page. mad…

ff27140

…e sure we return an array with complete keys

fixing test error; updating expected screenshot

0ec7546

updating how ManageScheduledReport shows notification to show it afte…

033500d

…r the refresh instead of before so that we can clearly see the notification for save and update

refactoring so that we use more consistent naming of dashboard id

79af2a3

removed duplicated translation key

8f108ef

adding a check that key exists in array before accessing it

ae2cbec

refactored so that we fix the race condition that was found earlier

3bd01e3

fixing issue where createReport function is not called or never runs …

6dc063f

…if the Ajax call is rejected or errors out

removed the manual triggering of ajaxloader

c7d60c6

getting idDashboard is taken from query instead of it in the hash

308fd16

getting idDashboard is taken from query instead of it in the hash

1d396b6

using getSearchParam to check from both query and hash when trying to…

21cd614

… get dashboard id

showing error when dashboardid is not valid or there is no dashboard …

ce48a5a

…name or export mapping is empty

making sure we remove both instances of idDashboard from url so that …

6303ef2

…we don't get issues with repeated auto-export when the parameter is in the hash

adding a check so that we can make sure that we only accept valid par…

baf8f26

…ameters for getWidgetReportMap function

adding the error text for invalid dashboard

33128d2

fixing the bug that a stale idDashboard in the hash can cause exporti…

618aabb

…ng of the wrong dashboard

Build vue files

100a9db

putback files that should not be there

bc845fd

added a helper function to get login module passed by the template (V…

d2babc3

…iew.php) so that we do not need to hardcode 'Login' when trying to get login module

making sure we do not trigger a refresh when we remove idDashboard fr…

8b92501

…om URL so that it we do not re-export the dashboard when the page is refreshed

adding a function in MatomoUrl to replaceUrl (w/o reloading the page)

0601a38

adding new test for new function

10fc5e6

updating built files

4fadd77

fixing issue for widget-to-report mapping so extra widget parameters …

a50ce56

…are matched independently

escaping html

eeae134

chippison force-pushed the dev-19806 branch from d9a9b52 to eeae134 Compare February 19, 2026 19:18

chippison added 2 commits February 20, 2026 09:02

making getWidgetReportMap only be callable internally and not be publ…

3addfe2

…ished in our api listing

updating screenshots

5f24a2f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

Export Dashboard to Scheduled Reports#24019

Export Dashboard to Scheduled Reports#24019
chippison wants to merge 58 commits into5.x-devfrom
dev-19806

chippison commented Jan 28, 2026 •

edited

Loading

Uh oh!

chippison Jan 28, 2026

Uh oh!

chippison Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Comments

Conversation

chippison commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Acceptance Criteria:

Checklist

Review

Uh oh!

chippison Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

chippison Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

chippison commented Jan 28, 2026 •

edited

Loading