Skip to content

mcutler81/Zendesk-Help-Center-Export-Scripts

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zendesk Guide Article Data Export

Summary

Navigating and using the Zendesk Help Center API can be challenging but is often necessary as a Zendesk Guide content curator.

Exporting Zendesk Guide data requires extracting the information using their API. The Python scripts included in this repository exports the data to a .csv file. This facilitates more control over Zendesk Guide Help Center information, and provides an expanded ability to obtain actionable data.

The process can be a little arduous, so any contributions, notes, feedback, etc. is greatly appreciated!

Dependencies

Instructions

As the scripts are currently written in Python, Python is the first necesarry installation (see above).

pip is suggested to install the necessary components. There are multiple ways to obtain pip, here is the documentation.

Once pip is installed, it is easy to install the necessarry libraries and use the export scripts in this repository.

  1. Go to the command line.
  2. Run pip install requests.
  3. Download the scripts contained in this repository.
  4. Edit the components in the script! Most important are the Zendesk credentials.
  5. Navigate to the directory where the script is located (for example, if it were located on the desktop, run cd /users/yourname/desktop).
  6. Run python articleid.py (or whatever script you are running).
  7. The .csv file with the list of article titles, article id's, etc. will be created in the current directory.

Notes

The Requests library suggests use of Python 3.

As it currently stands, the scripts outside of the Article_Information_Export folder return information as ONE COLUMN within a .csv file. This means if you run the script to print titles, all that will be returned is a list of titles.

If you don't change the endpoint (i.e. /api/v2/help_center/en-us/articles.json?sort_by=updated_at&sort_order=asc),then multiple exported csv's will line up.

This means that if you run the script for id's, then run the script for titles, all you will need to do is copy and paste the two outputs in a spreadsheet and they will correspond correctly.

For script editing purposes, use this guide

About

Python script that exports Zendesk Guide data to a .csv file.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%