Skip to main content

ArticleStatsRequest

Request object for the article statistics feature of the Faceting API.

Properties

PropertyRequiredTypeDescription
facetValuesCountFalseIntegerNumber of values to return for each metadata field.
articleIdsFalseList[String]The IDs of the target articles. Mutually exclusive with articleFilters and advancedFilter.
articleFiltersFalseMap[String, String]Filters on the articles' metadata fields that restrict the scope. Mutually exclusive with articleIds. It works in conjunction with advancedFilter, if set. See this guide for details.
advancedFilterFalseAdvancedFilterAdvanced filter clause on the articles' metadata fields. Allows expressing complex constraints. Mutually exclusive with articleIds. It works in conjunction with articleFilters, if set.
includeDuplicatesFalseBooleanWhether to include duplicate articles in the statistics.