Analytics API
Analytics API Overview
High-level overview of the Knowflow Analytics API for conversation data.
Analytics API Overview
The Knowflow Analytics API provides endpoints to access and manage conversation data collected across your deployments. This allows you to programmatically retrieve conversation lists, individual message details, and manage review statuses. These APIs power the Global Conversations page in the Knowflow application, enabling features like filtering, searching, and detailed review of user interactions.Key Features
- List Conversations: Fetch paginated lists of conversations with powerful filtering capabilities.
- Retrieve Messages: Get all messages for a specific conversation session.
- Review Management: Mark conversations as reviewed.
Authentication
All Analytics API endpoints require Bearer Token authentication. The token should be included in theAuthorization header of your requests.
Base URL
All API paths are relative to the following base URL:Available Endpoints
Detailed documentation for each endpoint is available:- GET /conversations: Retrieve a list of conversations.
- GET /conversations//messages: Retrieve messages for a specific conversation.
- POST /conversations//review: Mark a conversation as reviewed.
The API is designed to support the features described in the Global Conversations analytics section, including ‘All Conversations’ and ‘Review Mode’ functionalities.