Faqprime Popular Questions API

   

Answer

API Type

   JSON 

 

API Purpose 

   To get the list of popular questions. 


API Format

    <Helpdesk URL>/api/popular-postlist?keysecret=<Key Secret>&start=<Starting ID>

 

Parameters 

  • Helpdesk URL: Your Help Desk Home page URL i.e. https://help.example.com or https://example.myfaqprime.com

  • Key Secret: Keysecret generated for the key provided in the admin > control panel > Key Configuration

  • Starting ID (optional): Default value 0, this number represents from which index the next possible 10 posts should be shown. 

 

API Response 

  • error: true if there is an error in API and false if API is successful.

  • reason: Error Reason, present only if error is true.

    • Possible Reasons:

      • keysecret is missing

      • keysecret is not matching

  • time: Current Time in Unix Time format.

  • count: Number of post returned in the response.

  • posts: List of Questions in the following format

    • post-0/post-1...: Post Info in the following format.

      • postid: ID of the Question

      • title: Title of the Question

...