Makers can use this handy API endpoint to export all your notes, components, features, and subfeatures in seconds. This is useful if you want to migrate your data from one Workspace to another due to a company acquisition or if you want to report on your data outside of Productboard.
In this article:
- Exporting all notes
- Exporting all notes with associated features
- Stripping HTML from exported notes
- Troubleshooting
Exporting all notes
When exporting notes the following data will be exported:
- id: The notes id number.
- created_at: The date the note was created.
- note_title: The notes title.
- note_text: The text/body of the note.
- state: Whether the note is processed, unprocessed, or archived.
- creator_name: The name of the person who created the note.
- creator_email: The creator of the notes email address.
- owner_name: The member of your product team who is responsible for the area of the product that the note is about.
- owner_email: The email address of the note owner.
- user_name: The name of the user the feedback is from.
- user_email: The email address of the user the feedback is from.
- company_name: The name of the company the user is from who provided the feedback.
- company_domain: The domain of the company the feedback is from, e.g., productboard.com
- source_id: The id number of the source of the feedback, such as third-party integrations like Zendesk, Intercom, and Slack.
- source_url: The URL of the source of the feedback, such as third-party integrations like Zendesk, Intercom, and Slack.
- tags: The tags associated with the note.
To export all notes:
-
Make sure you're signed in to your Productboard workspace.
- Paste this URL into your browser:
https://[your_workspace].productboard.com/api/notes/exportNote: To locate your workspace name, see the article How can I find my workspace name?
- Insert your workspace's name into the URL. (When you're logged into Productboard, this will be at the beginning of the URL, before "productboard.com".)
- Press enter.
Exports include all notes, but only the content (description field) of some types of notes is included in the export:
-
The content of the note is included for all notes that are created in Productboard, the Portal, or via the Chrome extension or email.
-
The content of the note is not included for notes that are created via third-party applications such as Zendesk and Intercom. For these notes, all data is exported except for the content. (The note_text field is left blank.)
Exporting all notes with associated features
If you want to maintain a record of the features associated with certain notes, use this export option. This API endpoint will provide you with the same information as the one above and will also include the following:
- feature_name: The name of the feature the note is assigned to.
- feature_id: The id number of the feature.
- parent_feature_id: The parent feature id number if note is assigned to a subfeature.
To export all notes with associated features:
-
Make sure you're signed in to your Productboard workspace.
- Paste this URL into your browser:
https://[your_workspace].productboard.com/api/notes/export?export_type=with_features - Insert your workspace's name into the URL. (When you're logged into Productboard, this will be at the beginning of the URL, before "productboard.com".)
- Press enter.
Stripping HTML from exported notes
By default, the description fields of exported notes includes HTML formatting.
However it is possible to export notes without the HTML formatting.
To export without HTML, append the following parameter to the export URL:
&strip_html=trueSo the final URL you enter in your browser might look like this:
https://[yourworkspace].productboard.com/api/notes/export?export_type=with_features&strip_html=trueTroubleshooting
When exporting features and notes into a CSV, Excel will sometimes misformat special characters. In order to resolve this, the CSV needs to be imported to Excel in a specific manner.
In Excel:
- Go to the Data tab.
- Select in the database icon, Get Data...
- Select from text/ CSV, then pick the CSV export file.
- There will be a preview of the imported file. There’s nothing to change here but click on the Load button.
- Then the CSV is perfectly imported.
Comments
Very helpful - is there a way to export comments attached to notes?
Hi Shane Blake, Evan here from Productboard. Currently, it is not possible to export internal comments that may be associated with your notes. With that said, I have shared this as a feature request for our Product team to review further. Thanks for your feedback!
This is great, thank you for the feature.
In the future, do you think that we will be able to define time frames for the download, like: last 7 days, etc?
Also, will the functionality be added to postman?
Hi Leah Picone, Aoife here from Productboard. The option to define timeframes for the export is something that we have shared with the Product team to consider for the future, but it's not something we are actively working on at present. In terms of the export functionality being added to the main OpenAPI specification, I'll also pass this request on for you.
Thanks for your feedback!
Please sign in to leave a comment.