Table of Contents
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 your content can be super useful if you want to do some advanced filtering, run through content during meetings, or swap to a different platform.
At HelpDocs we take regular backups of all your data so you don't need to worry about data loss. That said if you need a copy of your data for any reason it's super easy to grab.
You can learn more about the API over in our our API docs 👾
Downloading a CSV File
If you wanna grab a quick copy of all or some of your articles to use as a spreadsheet or import to another piece of software a CSV is the answer.
Exporting All Content to CSV
You have a few options when downloading to CSV:
- Include working copy
- Include body
- Include both
- Include neither (recommended)
- Head to Settings > Migrations
- Under Export & Backup click
More next to CSV - Select your preferred options
By default the CSV will contain the following columns:
article_id | title | description | excerpt | tags | is_published | is_private | show_toc | editor_type | user_id | author_name | url | relative_url | category_id | category_title | category_url | category_relative_url | is_stale | stale_reason | stale_source | stale_triggered_at | updated_at | created_at |
Export Selected Content to CSV
You also have the option to export some of your content to CSV. This is super useful when you only want to upload certain content somewhere else or run through a selected amount of content in meetings.
- Head to Content (or click here)
- Select which categories or individual articles you want to export using the checkboxes
- To the top right click the Download button
- Select which option you'd like to download
- You're done ✨
CSV Download Options
You can choose to download your CSV file a few different ways by clicking the ▾ dropdown menu icon beside the Download CSV button.
Include Working Copy
Adds has_working_copy column and uses the working copy for text, body, and description fields. The CSV will contain the following columns:
article_id | title | description | excerpt | tags | is_published | is_private | has_working_copy | show_toc | editor_type | user_id | author_name | url | relative_url | category_id | category_title | category_url | category_relative_url | is_stale | stale_reason | stale_source | stale_triggered_at | updated_at | created_at |
Include Body
Includes the text and body fields. The CSV will contain the following columns:
article_id | title | description | text | body | tags | is_published | is_private | show_toc | editor_type | user_id | author_name | url | relative_url | category_id | category_title | category_url | category_relative_url | is_stale | stale_reason | stale_source | stale_triggered_at | updated_at | created_at |
Include Both
Has all the fields mentioned above ☝️
Include Neither
Includes only an excerpt field (the first 1000 characters of the article body) and no data about Working Copy.
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 > Migrations
- Under Export & Backup click More next to ZIP
- Click Download as ZIP
Exporting to Google Sheets
Creating a Google Sheet of your articles is just as simple.
- Head to Settings > API Keys 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")Don't forget to replace your_api_key in the link above with the API key you just created.
- Hit Return
- Save your new sheet
Google will pull all your articles from the HelpDocs API and display them in your sheet.
What did you think of this doc?
Hiding Articles from Public Search Engines
Understanding Search Results
