Question
How can I export my help center content? How do I download my articles? How do I save my help center theme code?
Answer
There isn't a prebuilt Zendesk tool to export articles. Zendesk recommends the options below:
- Leverage the Help Center API to export the data. Use the Rest API to back up your knowledge base content with Python.
- Use the kBackup, a third-party app developed to backup help center content at the click of a button.
To save your help center code, see the options below:
- To download your HTML, CSS, and Javascript code, import and export your theme and manifest file if you are on Guide Professional or Enterprise plans.
- For all the other plans, Zendesk recommends copying and pasting the code into a third-party text editor and saving it externally. There is no means to access the code using the help center API.
18 Comments
Hi everybody,
I've been working on an app that allows you to export a list of all articles in Zendesk Guide. It also exports the broken links & images for each article.
It is available on Zendesk's apps marketplace.
Register and get your free help center export
Hey all, I'm looking to use this script with Single Sign On and have been encountering some trouble. I pulled an API token to use instead of a password, as I do not functionally have one and using what I saw in this article
https://support.zendesk.com/hc/en-us/articles/231530827-What-are-my-credentials-for-API-access-when-using-SSO-to-sign-in-
But I am still prompted to enter a password. I assume this is just because of how the script is written but I am looking for advice on how to export my articles without a 3rd party app or paid service. Thanks!
What happened to the Knowledge Base to PDF app that used to allow the downloading of Zendesk guides to PDF format?
I've been wondering the same thing. I emailed support@kolibridigital.com to ask what happened.
I used this tool to download our data very easily. https://www.import2.com/ after watching this video https://www.youtube.com/watch?v=jWKTQM0eemY&ab_channel=CSVLoader
Hello,
We need to export roughly 10 articles for a client who cannot access our Zendesk Guide Knowledge Base. I'm considering two alternatives.
1. I'm able to print to a PDF in Chrome. Does printing each individual article to a PDF seem viable?
2. For the API, how would I install? How much work is involved to export all articles in a brand to a PDF or whatever?
Thanks.
The best option boils down to preference. If there are just a few articles, personally, I'll go with the PDF. If there's a few hundred and I have some knowledge on how to utilize API I'll go with that option. However, using API will only give you files in JSON format. You will then have to convert it to a human readable format or use third party applications to do the job for you.
Thank you Diane. We ended up exporting to PDF. It was apx. 120 articles, but worth the effort. Have a good week.
This is the tool:
https://csvloader.com
video instructions: https://www.youtube.com/watch?v=jWKTQM0eemY
The original post links to an article about exporting using the API and Python. Great. But it times out due to the API limits. When reading the article, it sounds like the code addresses this, but it doesn't. Does anyone know to address this flaw?
You can avoid this by throttling your API calls to stay under rate limit errors. Please review this article for more information: Best practices for avoiding rate limiting
Regards,
Dion
When we use the API to download articles from Help Center, the data in [body] is like
How can we extract real articles without such marks?
Qin Brian The API returns the articles body in HTML format. You can use a programming language like Python to strip out the html tags.
Alternatively, you can check the Help Center Manager app. It has a free trial and you can export the text of articles in CSV, HTML or Word.
Hello all - is there a way to include the full *body* of a Community (Gather) threads and comments in an export? The reporting options I see seem to just show the topic/title. Thanks in advance for any insight!
This information isn't available in Explore currently so you'd need to use the Help Center API to export the body of the posts and comments. More information on our API here: Help Center API
Let us know if you have another questions!
Hey all
As mentioned by the ZD agent above, its easily possible through the API.
<subdomain> /api/v2/help_center/en-gb/articles?page[size]=50
Make sure to use page size appropriately, it only sends random 30 in a list, so I used 50 as I had 50 articles.
Once you get the JSON use an online JSON to Excel converter and download the file - voila! all problems solved!
I have been able to successfully use the Help Center API to export posts and comments, but I am not able to download user-loaded images this way. My requests are getting filtered by Cloudflare.
Is there a way to download images stored by the user_images endpoint? I do not want to use a scraper library to defeat cloudflare, since the images already 'belong' to us.
Unfortunately, we don’t have a simple straightforward way of migrating this information, we’d recommend using the Help Center API, more specifically the article attachments endpoints in your case to export them.
Please sign in to leave a comment.