Skip to main content

Analytics API

The Analytics API lets you access the same functionality that is powering the kapa dashboard via API. By using the analytics endpoints, you can gain a better understanding of user interactions, preferences, and the performance of kapa.ai. You can access:

  • Aggregate and time series usage statistics
  • Common question clusters
  • Source retrieval statistics
  • All of your conversations by project
  • Details about all conversations
View full API reference

All available endpoints are listed in the API reference.

Defintions​

To better understand some terms in the API reference. Here is a list of terms used by it:

  • Thread
    • A Thread represents a conversation between a user and kapa.ai. a Thread contains one or more QuestionAnswer objects.
  • QuestionAnswer
    • A QuestionAnswer represents a single user question and kapa's answer to that question.