Sample Response

{
   "success": true,
   "message": "Filter list APIs",
   "errorCode": "",
   "result": [
      {
         "name": "beauty",
         "category": [
            {
               "name": "hair care & styling",
               "subCategory": [
                  {
                     "name": "hair care",
                     "articleType": [
                        {
                           "name": "conditioners",
                           "active": true,
                           "score": 18.296877,
                           "topBrand": "lorealparis",
                           "merchant": "all"
                        },
                        {
                           "name": "shampoos",
                           "active": true,
                           "score": 13.83099,
                           "topBrand": "mamaearth",
                           "merchant": "all"
                        }
                     ],
                     "active": true
                  }
               ],
               "active": true
            }
         ]
      }
   ]
}

Response Fields

Field	Description	Data Type
success	Indicates if API response is a success or not.	bool
message	Info about the response.	string
errorCode	Error code.	string
name	Name of the node Eg: field “name” under field “category” indicates it is the name of the category.	string
active	Active node or not Can invoke the leader board APIs based on this flag.	bool
topBrand	Top brand in the node, based on the access we have.	string
score	Sales velocity score of topBrand.	float

Exceptions and Error Conditions

The “BKG category name API” will look for matching data based on the filters applied. However, there are a few scenarios where the API may not be able to return a valid response.
For example

Invalid/Expired access token

In the above scenario, the “BKG category name API” would return with an error response. Example:

{
   "success": false,
   "message": "Invalid Access-Token",
   "errorCode": "FETCH_ERROR",
   "result": ""
}