Note: You are in the advanced users section. Only use this section if you are familiar with APIs.
Our public API provides access to all public knowledge base content, such as questions and categories.
Use the following URL to get questions:
my_account.helpjuice.com/api/questions
You can further filter and organize the returned questions via Query Parameters:
| Parameter |
Description |
Type |
Standard |
| category ID |
Only returns questions under this category. |
Round number |
zero |
| boundary |
Limits the number of returned questions. The maximum limit is 1000. If you need all of your records, you must use this parameter in conjunction with page. |
Round number |
250 |
| page | Handy for collecting questions in pieces. | Round number | 1 |
| to order |
Order the questions to be returned. Allowed: "name" and "updated_at". |
Wire |
position |
| segments [key] | Displays questions with the specified segmentation fields. This option accepts multiple parameters with different keys, allowing multiple segmentation fields to be specified. Example: "/? Segments [brand] = helpjuice & segments [name] = questions" | Wire | zero |
| related to | Only returns questions related to the parameterized question. |
Round number | zero |
It is also possible to place the questions within a specific language. To do this, simply specify the desired language in the URL using the following syntax:
my_account.helpjuice.com/api/en_US/questions
Response:
[
{
"id": 112828,
"name": "Embed videos in your knowledge base",
views: 394,
"account_id": 1885,
"accessibility": 1,
"description": null,
"email": "john.smith@example.com",
"is_published": true,
"is_juiced": false,
"codename": "embedding-videos-into-knowledge-base",
"language_id": 1,
"position": 0,
"created_at": "2014-11-24T20: 15: 53.865Z",
"updated_at": "2016-01-23T17: 00: 51.389Z",
"categories": [
{
"id": 7732,
"account_id": 1885,
"name": "Use our text editor",
"language_id": 1,
"accessibility": 1,
"created_at": "2014-11-19T16: 30: 44.994Z",
"updated_at": "2016-03-10T14: 58: 21.011Z",
"parent_id": 7728,
"lft": 10312,
"rgt": 10313,
"position": 3,
"codename": "with our text editor",
"index": 0
}]
}
]By default, questions are shown in JSON format. However, it is possible to retrieve them in 2 other formats: XLS and CSV. To do this, you just need to specify the format in the URL, as follows:
my_account.helpjuice.com/api/questions.xls => to get XLS spreadsheet
my_account.helpjuice.com/api/questions.csv => to get a CSV file
Fix the problem
- Blank Answer : If you don't see any data, or if you receive a corrupted file (in the case of XLS), it's because your knowledge base is marked internal only . Solution: If you are using a browser to access the data, please log in before making the request. Otherwise, you need to use your private key (accessible from Settings> API credentials) in a request parameter called api_key , such as:
- my_account.helpjuice.com/api/en_US/questions?api_key= MY_KEY
