Changing the Response for Article Search APIs

Changing the Response for Article Search APIs

As part of our effort to continuously improve our APIs, we recently discovered that the responses to our article search API did not provide all vital information related to help articles. So, we have decided to enhance the API by changing the response format. 

The response to this API used to be presented in the following format: 

{
  "data" : [ {
    "summary" : "test ",
    "modifiedtime" : "2017-11-30T09:26:03.000Z",
    "viewcount" : "0",
    "permission" : "ALL",
    "id" : "5000000009361",
    "title" : "test",
    "permalink" : "test",
    "category" : {
      "name" : "General",
      "id" : "5000000009268"
    },
    "vote" : {
      "like" : "0",
      "dislike" : "0"
    },
    "createdtime" : "2017-11-02T10:13:18.000Z",
    "status" : "Published"
  } ],
  "count" : 379

}

Going forward, the response to the same API will be presented in the following format:

{
  "data" : [ {
    "summary" : "Help articles are vital resources in user education. They are the first building blocks of an effective self-service setup.",
    "modifiedTime" : "2018-07-16T06:48:08.000Z",
    "latestVersionStatus" : "Published",
    "author" : {
      "photoURL" : null,
      "name" : "Hill",
      "id" : "5000000015935"
    },
    "creatorId" : "4000000012931",
    "modifierId" : "4000000012931",
    "dislikeCount" : "1",
    "permission" : "AGENTS",
    "likeCount" : "2",
    "title" : "Importance of a Knowledge Base",
    "authorId" : "4000000012931",
    "usageCount" : "3",
    "latestVersion" : "1.0",
    "feedbackCount" : "1",
    "createdTime" : "2018-07-16T06:48:08.000Z",
    "latestPublishedVersion" : "1.0",
    "viewCount" : "3",
    "id" : "22372000000281023",
    "permalink" : "importance-of-a-knowledge-base",
    "category" : {
      "name" : "General",
      "id" : "5000000017008"
    },
    "categoryId" : "4000000013240",
    "status" : "Published"
  } ],
  "count" : 379
}

Please keep in mind that the article search API will return both the old and the new responses for a period of one month. After this period, only the new response will be served and the modifiedtime , createdtime , and vote parameters from the old response will be deprecated. Therefore, we request you to modify your API-based code, wherever required, to accommodate this change. 

For any questions and clarifications, contact support@zohodesk.com .