This web service responds with information about which facets were the most popular among users over a selected period.
Method | Endpoint |
---|---|
POST |
/analytics/api/v2/searches/facets-heatmap |
Request example
The following lines show an example of a JSON request body:
{
"startDate": "2023-03-29",
"endDate": "2023-04-29",
"contentLocale": "fr-FR"
}
Field Name | Type | Required? | Description |
---|---|---|---|
startDate |
String | Yes | Inclusive start date of the period. Must be within the past year |
endDate |
String | Yes | Exclusive end date of the period. Must be later than the start date |
contentLocale |
String | Yes | Combination of language code and country code, separated by a hyphen |
All three of the request parameters described above are mandatory.
Response body
The following lines show an example of a JSON response body:
{
"startDate": "2023-03-29",
"endDate": "2023-04-29",
"results": [
{
"byFacetValue": [
{
"facetValue": "3.6.1",
"queryCount": 32
}
],
"facetKey": "Version",
"facetLabel": "Version",
"queryCount": 32
}
]
}
Field | Type | Description |
---|---|---|
startDate |
String | Inclusive start date of the period |
endDate |
String | Exclusive end date of the period |
facetKey |
String | Name of the facet |
facetLabel |
String | Localized name of the facet |
facetValue |
String | Value of the facet |
queryCount |
Number | Number of queries submitted by users who selected the facet |
Return code | Description |
---|---|
200 OK |
Returns 0 or more results. |