How To Export Your Helpjuice Data
Learn how to easily export your Helpjuice data and ensure you have a backup of all your valuable content.
Written by Amanda Helpjuice
Updated at October 9th, 2024, by Ivanna Parra
Table of Contents
Export a Category or Article as PDF, DOCX, or HTML files Customize the PDF download Export Your Data as an XLS or CSV File Data Dictionary More Export OptionsYou can export all of your Helpjuice data in XLS, and CSV, and Download PDFs with your content!
Export a Category or Article as PDF, DOCX, or HTML files
FYI All users can use this feature except Internal Viewers when they are not allowed to access the Dashboard. More on how you can restrict Dashboard access to Internal Viewers → Signing In Behavior
- Log Into Helpjuice
- On your Dashboard, locate the category or article
- Once located, hover over it
- Click Download PDF or DOCX, or Export HTML
- You will receive an email, click on Get my export to download the file
For Categories, you can select the subcategories and articles from the list, and we will generate the file and email it to you.
We keep internal blocks that are included in public articles removed from PDFs for data privacy reasons.
Customize the PDF download
With our new PDF Customization feature, you can adjust the PDF settings to match your needs. To access it, just go to Settings > Export Settings.
In that section, you'll be able to customize the header, add a logo and adjust its position, add custom text, and decide whether to include the Table of Contents or not!
Export Your Data as an XLS or CSV File
- Log Into Helpjuice
- On your Dashboard, click on your Profile Picture > Settings
- Access the Export Data section
- Export your Answers, Questions, Categories, Users, Searches, and Activities in XLS or CSV format.
You will receive the export in your email but Super Administrators and Administrators can also download any generated export from the Recent Exports section right below the Export Data section.
FYI Articles are composed of Titles (Questions) and Body text (Answers), so you need to download both files: Questions and Answers. The body will be in HTML, which allows you to easily check all references.
Data Dictionary
Answers
| Column | Description |
|---|---|
| id | The id of the body (answer) |
| question_id | The id of the article |
| user_id | The id of the author |
| body | The HTML of the article |
Questions
| Column | Description |
|---|---|
| codename | The article slug |
| id | The article's id |
| name | The article's title |
| description | The article's description |
| views | The article's views for all time |
| created_at | The timestamp when the article was created |
| updated_at | The timestamp when the article was updated |
| is_published |
|
| language_id | The language id. Check the language_id list → |
| category_id | The id of the parent category |
| joined_tag_names | The article's keywords |
| language_code | The language code. Check the language_code list → |
| next_expiration_on | The date on which the article is set to expire |
Categories
| Column | Description |
|---|---|
| id | Category's id |
| parent_id | If it's a Subcategory we will show the id of the parent category |
| name | Category/Subcategory name |
Users
| Column | Description |
|---|---|
| id | The id of the user |
| first_name | The user's first name |
| last_name | The user's last name |
| job_title | The user's job title |
| The user's email address | |
| notify_about_drafts |
Email Notification: Drafts Submitted For Review
|
| notify_about_articles |
Email Notification: Notify About New Published Articles
|
| weekly_analytics_subscribed |
Email Notification: Weekly Analytics Email
|
| weekly_articles_subscribed |
Email Notification: Notify Weekly About Changes In Followed Articles
|
| sign_in_count | How many times a user has logged in since they were added to the KB |
| current_sign_in_at | Is updated every time the user signs in |
| last_sign_in_at | Is the timestamp for the previous login |
| current_sign_in_ip | The IP address from which the user last signed in |
| last_sign_in_ip | The IP address from the user's previous login. |
| created_at | When the user account was created |
| updated_at | The last time the user account was updated |
| password_changed_at | The last time the user updated their password |
| role_id | The user's user role. |
| deactivated_at | Indicates when the user was deactivated |
Searches
| Column | Description |
|---|---|
| id | The id of the search that was performed |
| account_id | The id of the Knowledge Base account |
| query | The user's search terms submitted through the search bar |
| query_without_stopwords | A query without stopwords is a processed version of the query where common and insignificant words have been removed to focus on the most meaningful keywords. Removing stopwords helps improve search accuracy and efficiency. |
| ip |
The IP address of the user who performed the search
|
| search_count | The number of searches |
| found_answer | Found answer is a "Yes/No" metric, which indicates if at least one result/match was found |
| contacted_support |
A contact form is displayed when no result is found in the search bar
|
| created_at | The timestamp when the search was created |
| uppdated_at | The timestamp when the search was updated |
| clicked | Indicates how many of the searches the user clicked on when there is at least one result |
| indexed | It indicates whether the search was indexed or not on our backend |
| readings | When a user spends at least 10 seconds on that question |
| found_answers | The total results that were found |
| views | When a user accesses the question |
| language_id | The id of the language where the search was performed |
| search_type | Indicates whether searches were made by authenticated users (when the value is 1) or by anonymous users (when the value is 0). |
| user_id | The id of the user that performed the search |
Activities
| Column | Description |
|---|---|
| Created at | When the action was performed |
| Owner | The user who performed the action |
| Action | The action that was performed |
| Trackable | The resource that the action was performed on |
More Export Options
- Super Administrators can export a backup from the Backup & Restore page. Learn more about this option → Backup & Restore Section
- You can use our API to export your data and more! Check our API v3 documentation → Helpjuice API v3