Welcome To Our Customer Service Portal


Nanorep SEO and knowledge-base export API

Overview

The SEO and Knowledge Base Export API that is offered as part of the Nanorep package is an interesting little API which “pushes” question and answer information from the Nanorep knowledge base into the page source. This means that 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 Nanorep widget.

 

API specifications


The URL format is:

https://my.Nanorep.com/common/api/kbExport.xml?param=value&param=value

 

Script sample:

https://my.Nanorep.com/common/api/kbExport.xml?username=<username>@<account name>&pw=<password>&kb=<KB name>&plainText=true
 

Here is an example of how your script may look like:

https://my.Nanorep.com/common/api/kbExport.xml?username=test@Nanorep&pw=test1234&kb=English&plainText=true

 

 

 

General parameters:

 

Parameter

Usage

Example

username

Your Nanorep login name. You must have knowledge base access privileges in order to use the API (required)

username=john@company

pw

Your Nanorep password (required)

pw=1234567

kb

The knowledge base to export from (required)

kb=English

maxItems

How many items to fetch

maxItems=50

skip

The place in the list from which to start fetching. eg. use skip=10 to start fetching the list from the 11th item

skip=10

format

xml/json (default:xml)

format=json

 

Filter parameters:

 

 

 

Parameter

Usage

Example

byPopularity

If you use true (recommended), the most popular articles will show up first in the search results.

Note: offline articles won't be included if the parameter is set to true

byPopularity=true 

days

Use to show the most popular answers given by the Nanorep widget during the last x days. This parameter only works with byPopularity=true

days=30

labelId

Use to show answers from a specific label only. You can find this information in the Nanorep console when editing a label.

labelId=ABC123

textFilter

Use to show answers that contain a certain word or phrase.
Note: The value of this parameter must be base64 encoded. As it is used in a URL, replace "=" with "_", and "+" with "|". Example: "hello" becomes "aGVsbG8_"

textFilter=aGVsbG8_

context

Use to show answers that have the specified context. Usage format: category:value. You may use more than one category/value pairs by separating the pairs with commas, eg: Manufacturer:Sony, Device:iPhone **

context=TWFudWZ

hY3R1cmVyOlNvbn

ksRGV2aWNlOm

lQaG9uZQ__

 

 

 

modifiedSince

Format: yyyy-MM-ddTHH:mm.

If used, only articles modified since this date are included.

modifiedSince=2013-11-01T17:00

includeHiddenFaqItems

Include Hidden FAQ items. i.e. article marked as "hide this answer from the dynamic FAQ widget"

includeHiddenFaqItems=tru

 

 

 

URL Examples

 

Full export with stripped body:

 

https://my.Nanorep.com/common/api/kbExport.xml?username=

USER@ACCOUNT&pw=PASSWORD&kb=English&byPopularity=true&plainText=true

 

Articles with the word 'iPhone' in them:

 

https://my.Nanorep.com/common/api/kbExport.xml?username=

USER

@ACCOUNT&pw=PASSWORD&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 &amp; 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>Nanorep is a self-service customer support &amp; service solution. It is designed to improve customer engagement and prevent website or cart abandonment by delivering instant, accurate answers to customers&#39; questions with no waiting queues what so ever.<br />&nbsp;<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&amp;A&rsquo;s traffic.</p><p>In these cases, it won&#39;t be necessary to upgrade to a premium package.</p><p>However, in cases where there is a consistent increase in Nanorep&#39;s usage for more than a month, a notification on the outgrown support package&nbsp;will be sent to the customer and an upgrade plan will be offered.</p>]]></body>

        </article>

                <meta skipped='0' exported='3' totalArticles='3'/>

</NanorepExport>

 

 

 

Code samples

ASP.net