Retrieving Answers through API

Note: You're located in section for advanced users. Please use this section only if you're familiar with API's.


Use the following URL to retrieve answers:

my_account.helpjuice.com/api/answers


Query Parameters:

Parameter
Description
Type
Default
limit
Limits the number of answers returned. The maximum limit is 1000. If you need all your records, you'll have to use this parameter combined with page.
Integer
250
pageUseful to retrieve answers in chunks.Integer1
category_id
Retrieve answers inside specific category
Integer


It's possible to scope the answers within a specific language. To do so, just provide the desired language in the URL using the following syntax:

my_account.helpjuice.com/api/en_US/answers


Response:

id,question_id,body
80028,155573,<p>Hey</p>
80027,155572,"<p>Changes the account's domain name for hosted service. If account does not yet have a ISL domain, the domain with passed name will be created.</p>"

By default, answers will be showed in CSV format. However, it's possible to retrieve them in one more format: XLS. To do so, you just need to specify the format in the URL, as follows:

my_account.helpjuice.com/api/answers.xls => to retrieve XLS spreadsheet

Troubleshooting

  • Blank response: if you are not seeing any data, or you are receiving a corrupted file (in case of XLS), that's because your Knowledge Base is marked as internally only. Solution: if you are using a browser to access the data, just sign in before making the request. Otherwise, you'll need to use your Private Key (accessible under Settings > API Credentials) in a request parameter called api_key, like:
    • my_account.helpjuice.com/api/en_US/questions?api_key=MY_KEY
Was this article helpful?

Can't find what you're looking for?

Contact Support