How to Export Zendesk Guide Data as CSV
Here is a script that exports Zendesk Guide Article information as a CSV:
https://github.com/scotthavard92/Zendesk-Help-Center-Export-Scripts
This tool uses the Zendesk Help Center API(https://developer.zendesk.com/rest_api/docs/help_center/introduction) to pull Guide Information and populate it in a csv file. This will output values such as Article Id, Article Title, and Vote Count.
The output looks like:
Here is a nifty video overview and instructional:
Let me know if you have any questions!
-
Thanks @... that did the trick! Greatly appreciate you responding and creating this script.
-
@Scott,
I get the following error
File "C:\Users\********\AppData\Local\Programs\Python\Python38\lib\encodings\cp1252.py", line 19, in encode
return codecs.charmap_encode(input,self.errors,encoding_table)[0]
UnicodeEncodeError: 'charmap' codec can't encode character '\u2212' in position 17650: character maps to <undefined>I have tried replacing ‘NFKD’ with ‘NFKC’, 'NFD', and 'NFC' and maybe I am not correctly modifying the code as Karen said. But I do have some Chinese and Japanese articles if that helps.
Mike
-
Hi @... 👋
Thanks so much for the awesome script and instructions! When I exported the file, it only seemed to include our public facing articles (permissions = visible to everyone) but didn't include our internal articles (permissions = visible to agents and managers). I couldn't spot anything in the script I could tweak and wanted to see if you had any suggestions?
Many thanks,
Hannah
-
Hey Hannah,
I believe this script is using our Help Center API which I've linked for you. You want to take a look there to see if you can get the data you're looking for. Hopefully Scott can get back to you with more guidance.
Cheers!
-
This was extremely helpful and comprehensive. Thank you!
Just a quick note for those who use SSO (we do with Google) - I simply entered my Google password when authenticating during the export and it worked!
-
Hi everybody,
I've been working on an app that enables you to export a list of all articles in Zendesk Guide and their content. The broken links & images for each article are automatically detected and provided in the export. Both at no cost.
It is available on Zendesk's apps marketplace: Help Center Export
---This comment has been edited by the Zendesk Community Team so that the link conforms to our Community Code of Conduct
-
Hello Zendesk! (Maybe @...?)
I previously have been advising on using OAuth to export all articles. I recently have found that using OAuth doesn't actually export that data by default anymore! Now using Basic Auth or OAuth only exports the fully public/published docs.
Any way to work around this? I tried to edit the endpoint to specify the internal section and category, but it returns no data.
This may have been a security thing? The OAuth token should be enough security in its own. Either way, most of us need the exports to include internal articles. Would love if the endpoint got reverted or to get an advice on a different approach. I can edit my scripts to try and help enable this for everyone else!
-
Alternatively, if someone is still having success exporting articles internally let us know! It could be good to rule out any settings that we have configured on our end.
-
Wondering if anyone has discovered or developed a workaround for the OAuth issue that results in only exporting published articles but not unpublished/internal articles.
-
So, we had to install "The Unarchiver" from the Mac App Store to open the zip file (rar). I had to also use IDLE to open/edit the script.
I got slightly confused. I thought that .zip archive is a different format, other than .rar. For instance, the information about CSV format backup was clear. But I am still confused about how to convert rar into zip.
Please sign in to leave a comment.
40 Comments