Data Migration
How to import and export report configurations, migrate between Confluence spaces, and understand what happens when the app is uninstalled.
Importing Report Configurations via JSON Recipe
A JSON recipe is a complete export of a report's configuration - data source, expansions, columns, filters, and view type. Use it to recreate any report on a new page or in a new space without manual re-configuration.
How to Import a JSON Recipe
- Open a Confluence page in edit mode and insert the macro.
- In the macro editor, navigate to the Import tab in the right panel.
- Paste the JSON recipe into the text area.
- The app automatically rebuilds the full report configuration - data source, expansions, columns, filters, and view.
- Review results in Live Preview to confirm the report is working correctly.
- Click Save to publish the report to the page.
What a JSON Recipe Contains
| Element | Included in Recipe? |
|---|---|
| Data Source (Spaces or CQL) | Yes |
| CQL query or space/page selection | Yes |
| Loaded expansion groups | Yes |
| Column definitions (label, block type, field path, formatting) | Yes |
| Filter rows (operator, property, value) | Yes |
| Report Type (Table, List, Grid, Paragraph, Charts) | Yes |
| Result Limit | Yes |
| Actual report data (Confluence content) | No - data is always fetched live |
Exporting Reports for Backup
There are two types of exports - data export and configuration export. Use both for a complete backup strategy.
Export Report Data
- Open the published report on a Confluence page (or in the macro editor).
- Click the Export button in the center panel.
- Choose CSV (for spreadsheet tools) or JSON (for developer use).
- The file downloads automatically - store it locally or in a shared drive.
Export Report Configuration (JSON Recipe)
- Open the macro editor for the report.
- Navigate to the Import tab in the right panel.
- Click the Copy JSON button - copies the full configuration to your clipboard.
- Paste into a text file, a shared Confluence page, or a version-controlled document.
Best Practice: Store JSON recipes on a dedicated "Report Library" Confluence page. Document each recipe's name, purpose, target spaces, and use case so your team can find and reuse them.
Migrating Between Confluence Spaces
When you need to move a report from one Confluence space or page to another, use the JSON recipe workflow.
Step-by-Step Migration
- Open the source report in the macro editor.
- Navigate to the Import tab → click Copy JSON to export the configuration.
- Open the destination Confluence page (in the target space) and insert a new macro.
- In the new macro editor, navigate to the Import tab and paste the JSON recipe.
- Update the Data Source if the target space is different:
- If using Spaces mode: re-select the target space(s) in the source picker.
- If using Custom CQL: update the
spacevalue in the CQL query (e.g., changespace = "OLD"tospace = "NEW").
- Review in Live Preview - confirm results are correct for the new space.
- Click Save.
Cross-Space Migration Checklist
| Step | Action |
|---|---|
| Export config | Copy JSON recipe from Import tab |
| Create new macro | Insert macro on destination page |
| Import config | Paste JSON recipe in Import tab |
| Update data source | Change space selection or CQL space filter |
| Verify permissions | Confirm viewer has access to target space |
| Verify columns | Check that all fields are still available (same expansions needed) |
| Save and publish | Save macro, then publish the Confluence page |
What Happens If the App Is Uninstalled
If Reports, Charts, Templates, CQL & Export for Confluence is uninstalled from your Confluence Cloud site:
| Element | What Happens |
|---|---|
| Report macros on pages | Remain on pages as placeholder blocks - they do not disappear |
| Report data displayed | No longer rendered - placeholders show a "macro unavailable" message |
| JSON recipes stored on pages | Remain intact - text content is unaffected by uninstall |
| Confluence page content | Unchanged - uninstalling the app does not delete or modify page content |
| Re-installing the app | Restores full macro functionality - reports become live again automatically |
Important: Your Confluence pages and their content (including any JSON recipes stored as text) are never deleted when the app is uninstalled. Re-installing the app restores all reports to their previously configured state.