Skip to main content

Faceting API

The article index can be queried to get statistics about the metadata fields, also known as facets.

Endpoints

EndpointDescriptionRequest200 Response
POST /v1/articles/statsGets statistics for the indexed articles.ArticleStatsRequestArticleStatsResponse

POST /v1/articles/stats

Gets statistics for the indexed articles.

Examples

Example

Request

{
"facetValuesCount": 5
}

Response

{
"totalCount": 1234,
"facets": [
{
"name": "metadata_field",
"totalCount": 321,
"values": {
"value A": 16,
"value B": 8,
"value C": 4,
"value D": 2,
"value E": 1
}
}
],
"publishedDateMin": "2000-01-01T00:00:00Z",
"publishedDateMax": "2024-12-31T00:00:00Z"
}