Skip to main content

Analytics API

Everything in the analytics dashboard is also available programmatically, for syncing into your own analytics systems or building custom reporting:

  • Activity: aggregate activity statistics (query counts, feedback, unique users, deflections).
  • List Threads: paginated conversation threads with question-answer pairs, suitable for syncing into third-party analytics systems.
  • Top Questions: the most-frequently-asked question clusters across all conversations, grouped into completed periods (weekly, monthly, or quarterly).
  • Coverage Gaps: question clusters where Kapa was uncertain about its answer, an actionable signal for documentation gaps. Uses the same period structure as Top Questions, with an additional suggestion field per cluster.

Tracked user information is included when exporting conversations via List Threads or List End Users; see user tracking for how to attach user identities to requests.

For authentication and general API usage, see the HTTP API overview and the full API reference.