Responses
Responses Facet Search
Searches for q in the selected indices and groups results by the facets field.
get/api/responses_facet/
Query parameters
qstring required
The query string used for searching. See Query Syntax for more details.
Example:domain:example.com
facetsField[] required
A list of fields to group search results by.
[ "geo.country" ]
indicesIndiceLabel[]
A list of indice labels to search in. If not provided, the search will be performed in the default (most relevant index).
Call indices endpoint to get the list of available indices.
A list of indices where the search will be performed.
ℹ️ Unlike other search tools, Responses search does not have a default index.
If indices is not specified, the search is conducted using the latest publicly available internet scan data,
which is updated in real time.
[ "2025-09-24", "2025-09-02" ]
sizeinteger
Number of search results to return for each facet.
Response
Facet Search Results
Example response
{
"aggregations": [
{
"key": [
"any_valid_key"
],
"doc_count": 1675
}
]
}