Drilling Down Through Categories via REST API

Overview

Description	Drilling down through hierarchical categories
Resource Path	/analytics/facets
HTTP Method	POST
Request/Response Format	application/json
Authentication	Basic

Sample cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -v https://localhost:9443/analytics/facets -d '{"tableName" : "sampleTableName","fieldName" : "sampleFieldName","categoryPath" : ["parent", "child", "grandChild"],"query" : "timestamp : [1213343534535 TO 465464564644]","scoreFunction" : "weight*popularity"}' -k

Example

POST https://localhost:9443/analytics/facets
{
        "tableName" : "sampleTableName",
        "fieldName" : "sampleFieldName",
        "categoryPath" : ["parent", "child", "grandChild"],
        "query" : "timestamp : [1213343534535 TO 465464564644]",
        "scoreFunction" : "weight*popularity"
}

Sample output

{
	"categoryPath" : ["parent", "child", "grandChild"],
	"categories : {grandGrandChild1 : 15, grandGrandChild2 : 25, grandGrandChild3 : 42}
}

REST API response

HTTP status code

200

For descriptions of the HTTP status codes, see HTTP Status Codes.