Exporting & Backing Up Your Articles
At HelpDocs we take regular backups of all your data, so you don't need to worry.
That said, if you need a copy of your data for any reason, it's super easy to grab it from our API.
Exporting as JSON
The HelpDocs API is the most flexible way to export data. You can query articles by category, and even select which fields you'd like to view. You can learn more about the API in our API docs.
Downloading a .csv file
If you want to grab a quick copy of all your articles to use as a spreadsheet, or import to another piece of software, a CSV is the answer.
- Head to Settings > API and create an API key with Read permissions
- Your .csv is now available at
https://api.helpdocs.io/v1/article?format=csv&key=your_api_key
The table will have the following columns:
article_id | category_id | title | description | text | body | tags | is_published | is_private | show_toc | editor_type | user_id | author_name | url | relative_url | is_stale | stale_reason | stale_source | stale_triggered_at | updated_at | created_at |
Downloading a .zip file
You can export your categories and articles to a .zip file and it'll sort them out into folders for you, with metadata included as .yaml files.
- Head to Settings > API and create an API key with Read permissions
- Your .zip is now available at
https://api.helpdocs.io/v1/article?format=zip&key=your_api_key
Exporting to Google Sheets
Creating a Google Sheet of your articles is just as simple.
- Head to Settings > API and create an API key
- Create a new Google Sheet
- In the top left cell, type =IMPORTDATA("https://api.helpdocs.io/v1/article?format=csv&key=your_api_key")
- Hit Return
- Save your new sheet
Google will pull all your articles from the HelpDocs API and display them in your sheet.
