API Change log

2019.11.13

  • no changes.

Released 2019.05.29

  • New: Added the new /language-detector endpoint.
  • New: Added the new "language-detector" option in the /tracking/events endpoint.

Released 2019.05.15

  • New: The KM API can now track information about the SDK version used as part of the User information.

Released 2019.04.03

  • New: There is a new API endpoint in the KM API that allows you to retrieve multiple contents passing a list of ids, with a single request. 
  • Update: The /tracking/session endpoint of the KM API now returns not only the sessionToken, but also the sessionId. This allows developers to retrieve and use sessionId to filter results in Dashboards.

Released 2019.03.06

  • Update: The API had the capacity to split a query if it was too long to process. However, this wasn't possible if the query did not contain any punctuation symbols. This is now corrected and the API can now split a query even when the query does not contains any punctuation symbols. 
  • Update: We added a "maxDepth" parameter to the /categories/slug/{slug} endpoint so that you can retrieve not only the first level of categories but the whole category tree. 
  • Fixed: The API was throwing an "error 500" when users asked questions that did not exist in the knowledge base. This is now fixed and it now returns "error 404" instead. 

Released 2019.02.20

  • Fixed: The Developers Portal's "try out" feature for the KM endpoint /contents/slug/{slug} returned an error when a user sent booleans as "true" or "false", because it only accepted the values 0 or 1. This is now fixed and all API endpoints accepts both options: true/false or 0/1.

Released 2019.01.23

  • Fixed: The engine could generate duplicate entries when a user rated contents. This is now fixed.

Released 2019.01.09

  • Update ICS initialization to avoid using survey when they are not needed
  • Track Development as Internal test

Released 2018.12.12

  • New: API Endpoint /categories/{categoryId}/contents that returns the contents in a category ordered as defined in the KM Application.
  • Update Sentry to only report 5xx errors and requests that took more than 5s to be processed.
  • Update rate limits library to 1.6 
  • Avoid tracking any user information as default. Two need options available to log the users' browser and IP. 
  • API now accepts multiple signing keys to generate access tokens. This allow Inbenta to rotate signing key without impacting clients.

Released 2018.11.07

  • Fixed: Depth value in the API /categories endpoint return correct values.
  • Add cache to search endpoint in order to improve efficiency when receiving equal searches. Specially useful for deflection tools.

Released 2018.10.17

  • Added: New functionality to retrieve contents sorted by last modified.
  • Added: Updated the API Routes with the categoryId parameter in the /contents endpoint to define it is a string that contains category ids separated by comas.
  • Added: Updated API and SDK tracking documentation.

Released 2018.10.03

  • Updated rate limits. The limits are now up to 5 times higher than before.

Released 2018.09.19

  • Added: New endpoints:
    • GET /user-questions
    • GET /user-questions/<id>
    • GET /user-questions/slug/<slug>
    • GET /content/<id>/user-questions
    • GET /user-question/<id>/contents
  • Added: New tracking event click_user_question
  • Improvement: Allow multiple categories in /contents endpoint

Released 2018.08.22

  • Improve popular: now accept multiples categories, separated by a comma
  • Improve push: now accept multiples categories, separated by a comma

Released 2018.08.08

  • Updated: Tracking of endpoint GET /cross-selling/{crossSellingId}
  • Updated: Tracking of endpoint GET /cross-selling/search

Released 2018.07.25

  • Added: new events to endpoint POST /tracking/events. New events: instant_search, instant_click and contact_search.
  • Added: new parameter tracking to endpoint POST /search. When true, the endpoint will do the tracking of a search (Default: true).
  • Added: new parameter tracking to endpoint GET /contents/{contentId}. When true, the endpoint will do a click in the requested content (Default: true).
  • Added: new parameter tracking to endpoint GET /contents/{contentId}. When true, the endpoint will do a click in the requested content (Default: true).
  • Added: new parameter tracking to endpoint GET /contents/slug/{contentSlug}. When true, the endpoint will do a click in the requested content (Default: true).

Released 2018.05.16

  • Fixed: Tracking event rate without comment save it as null not as '-'

Released 2018.05.02

  • Fixed: /autocompleter/data endpoint not return expired contents and not published contents.

Released 2018.04.04

  • Fixed number of contents on 'categories' endpoints
  • Added:  "matching details" to search endpoint