Bold360 AI SEO and knowledge-base export API
The SEO and knowledge base export API "pushes" question and answer information from the Bold360 AI knowledge base into the page source.
This way the information becomes visible to search engine bots, resulting in more traffic being driven to the website, and users being able to ask questions via Google, or any other search engine, and being directed straight to your website without using the Bold360 AI widget.
API specifications
The base URL format of the API is the following:
https://my.Nanorep.com/common/api/kbExport.xml?param=value¶m=value
The following is a sample script with all relevant data provided:
https://my.Nanorep.com/common/api/kbExport.xml?account=ACCOUNTNAME&apiKey=APIKEY&kb=English&plainText=true
General API parameters
Parameter |
Usage |
Example |
---|---|---|
username | Your Bold360 AI login name. You must have Knowledge Base access privileges to use the API (required) | username=john@company |
pw |
Your Bold360 AI password (required) |
pw=1234567 |
kb |
The Knowledge Base to export from (required) |
kb=English |
maxItems |
The number of items to retrieve |
maxItems=50 |
skip |
The place in the list from which to start retrieving. For example, use skip=10 to skip the first 10 list items and retrieve the rest. |
skip=10 |
format |
xml/json (default:xml) |
format=json |
Filter parameters
Parameter |
Usage |
Example |
---|---|---|
byPopularity |
Set this parameter to true (recommended), to display the most popular articles first in the search results. Note: Offline articles will not be included if the parameter is set to true. |
byPopularity=true |
days |
Displays the most popular answers given by the Bold360 AI widget during the last x days. This parameter does only have an effect if byPopularity is set to true. |
days=30 |
labelId |
Displays answers from a specific label only. You can find this information in Bold360 AI when editing a label. |
labelId=ABC123 |
textFilter |
Displays answers that contain a certain word or phrase.Important: The value of this parameter must be base64 encoded. As it is used in a URL, replace "=" with "_", and "+" with "|". For example, "hello" must be defined as "aGVsbG8_" |
textFilter=aGVsbG8_ |
context |
Displays answers that have the specified context in category:value format. You may use more than one category:value pairs separated by commas. For example, Manufacturer:Sony, Device:iPhone ** |
context=TWFudWZ hY3R1cmVy Ol Nvbn ksRGV2aWNlOm lQaG9uZQ__ |
modifiedSince |
Format: yyyy-MM-ddTHH:mm. If used, only articles modified since this date are included. |
modifiedSince=2013-11-01T17:00 |
includeHiddenFaqItems |
Includes hidden FAQ articles, which are marked by the "hide this answer from the dynamic FAQ widget" option. |
includeHiddenFaqItems=tru |
API URL Examples
- Full export with stripped body
-
https://my.Nanorep.com/common/api/kbExport.xml?account=ACCOUNTNAME&apiKey=APIKEY&kb=English&byPopularity=true&plainText=true
- Articles with the word 'iPhone' in them
-
https://my.Nanorep.com/common/api/kbExport.xml?account=ACCOUNTNAME&apiKey=APIKEY&kb=English&byPopularity=true&maxItems=20&textFilter=aVBob25l
XML Response example
<?xml version="1.0" encoding="utf-8"?>
<NanorepExport account='Nanorep' kb='633763325358580000'>
<article id='633915887117827492' isOffline='False'>
<title>
<![CDATA[How much does it cost?]]>
</title>
<body>
<![CDATA[<p>For detailed packages & pricing information, <a href="http://www.Nanorep.com/index.php?page=prices" target="_blank">click here</a></p>]]></body>
</article>
<article id='633915887117827588' isOffline='False'>
<contextInfo>
<context id='Page Type' value='General' />
</contextInfo>
<title>
<![CDATA[What is Nanorep?]]>
</title>
<body>
<![CDATA[<p>Bold360 ai is a self-service customer support & service solution. It is designed to improve customer engagement and prevent website or cart abandonment by delivering instant, accurate answers to customers' questions with no waiting queues what so ever.<br />&<br /></p>]]></body>
</article>
<article id='141286' isOffline='False'>
<title>
<![CDATA[What happens when I exceed the number of questions in a given month?]]>
</title>
<body>
<![CDATA[<p>We understand that due to seasonal changes, promotions or campaigns, there can be spikes in the Q&A’s traffic.</p><p>In these cases, it won't be necessary to upgrade to a premium package.</p><p>However, in cases where there is a consistent increase in Bold360 ai's usage for more than a month, a notification on the outgrown support package&will be sent to the customer and an upgrade plan will be offered.</p>]]></body>
</article>
<meta skipped='0' exported='3' totalArticles='3'/>
</NanorepExport>