Stats

Faq

Public FAQ portal engagement: views and votes per article, lifetime counters. Not scoped to the filter row - views and votes are counters on the items, not events in a window.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/stats/faq

Authorisation: Minimum role: USER

Request arguments

Name	Type	Source

Request body example

No input arguments

Response

Status: 200 (OK)
Type: DTO_stats_faq

Wrapper: DTO_response_wrap

Other statuses: 400 (BadRequest), 401 (Unauthorized), 403 (Forbidden), 429 (TooManyRequests)

Response body example

DTO_stats_faq

Name	Type	Description
portal_enabled	Boolean	Whether the public FAQ portal is live; false renders the tab's enable prompt.
approved_count	Int32	The whole approved corpus, including chat-bot-only and uncategorized items.
listed_count	Int32	Items the portal lists (approved, categorized, not chat-bot-only), before the plan cap.
total_views	Int64	Total views
votes_up	Int64	Votes up
votes_down	Int64	Votes down
articles	DTO_stats_faq_article[]	Per-article engagement: every listed article plus any unlisted one that still collected views or votes (direct links work for chat-bot-only items). Views-descending, capped.

DTO_stats_faq_article

Name	Type	Description
id	Int32	Id
question	String	Question
category	String	Category name; null when the item is not categorized (and so not listed).
listed	Boolean	False for items reachable only by direct link (chat-bot-only or uncategorized).
views	Int64	Views
votes_up	Int32	Votes up
votes_down	Int32	Votes down

Generated Aug 22, 2026 09:36