search

scotthavard92 / Zendesk-Help-Center-Export-Scripts

Python script that exports Zendesk Guide data to a .csv file.
MIT License
38 stars 20 forks source link

readme

Zendesk Guide Article Data Export

Summary

Exporting Zendesk Guide data requires use of the Zendesk Help Center API. The Python scripts included in this repository export data to a .csv file. This facilitates more control over Zendesk Guide Help Center information through access to actionable data.

Feedback is Welcome\ The process can be a little arduous, so any contributions, notes, feedback, etc. on this repository is greatly appreciated!

Dependencies

The scripts are currently written in Python. Python is therefore the first necesarry installation.

pip is one way to install the other necessary components. These instructions assume the use of pip.

Instructions

Select the script to run. There are specific instructions in the script's corresponding directory. The Article_Information_Export script will export all data into one .csv. The other scripts export singular data types(such as "titles") into a .csv.

To run a script from this repository:

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

Feel lost? If you are unsure of where to start, use the Article_Information_Export script. There is a corresponding YouTube video walkthrough.

Notes

The Requests library suggests use of Python 3 over Python 2.

Follow the Zendesk API guide to edit the scripts.