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