Pragence

Analytics API

GET /api/v1/conversations/analytics/overview

Summary: Get Conversation Analytics

Get conversation analytics.

Response Schema (ConversationAnalyticsResponse - Status 200):

PropertyTypeRequiredDescription
total_conversationsinteger*
total_messagesinteger*
avg_messages_per_conversationnumber*
positive_messagesinteger*
negative_messagesinteger*
sentiment_distributionobject*
topic_distributionobject*
conversations_by_statusobject*
conversations_by_productobject*

GET /api/v1/analytics/usage

Summary: Get Usage Stats

Get system usage statistics.

Returns aggregated usage metrics for the specified time period. Defaults to last 24 hours if no dates provided.

Response Schema (UsageStats - Status 200):

PropertyTypeRequiredDescription
total_queriesinteger*
total_documentsinteger*
avg_query_latency_msnumber*
avg_iterationsnumber*
avg_critique_scorenumber*
success_ratenumber*Query success rate
period_startstring*
period_endstring*

GET /api/v1/analytics/queries/recent

Summary: Get Recent Queries

Get recent query analytics.

Returns the most recent queries with their performance metrics.


GET /api/v1/analytics/queries/thread/{thread_id}

Summary: Get Thread Queries

Get all queries for a conversation thread.

Returns queries in chronological order.


GET /api/v1/analytics/metrics

Summary: Get Query Metrics

Get query performance metrics.

Returns latency percentiles and performance statistics.

Response Schema (QueryMetrics - Status 200):

PropertyTypeRequiredDescription
total_queriesinteger*
avg_latency_msnumber*
min_latency_msnumber*
max_latency_msnumber*
p50_latency_msnumber*
p95_latency_msnumber*
p99_latency_msnumber*
period_daysinteger*

GET /api/v1/analytics/coverage-gaps

Summary: Get Coverage Gaps

Content-gap report (kapa-style): clusters low-confidence / unanswered questions into themes, each with a finding and a documentation recommendation.

Response Schema (CoverageGapsReport - Status 200):

PropertyTypeRequiredDescription
window_daysinteger*
questions_analyzedinteger*
clustersarray of CoverageGapCluster

GET /api/v1/widgets/{widget_id}/analytics/metrics

Summary: Get Widget Metrics

Get comprehensive metrics for a widget.

Returns conversation, message, visitor, and quality metrics for the specified time period.

Response Schema (WidgetMetricsResponse - Status 200):

PropertyTypeRequiredDescription
total_conversationsinteger*
conversations_todayinteger*
conversations_this_weekinteger*
conversations_this_monthinteger*
avg_messages_per_conversationnumber*
total_messagesinteger*
messages_todayinteger*
user_messagesinteger*
assistant_messagesinteger*
total_visitorsinteger*
unique_visitors_todayinteger*
returning_visitorsinteger*
avg_session_duration_secondsnumber*
positive_feedback_countinteger*
negative_feedback_countinteger*
feedback_rationumber*
avg_response_latency_msnumber*
widget_opensinteger*
messages_per_visitornumber*

GET /api/v1/widgets/{widget_id}/analytics/conversations

Summary: Get Widget Conversations

Get list of conversations for a widget.

Returns conversation summaries with visitor info and metrics.

Response Schema (WidgetConversationsListResponse - Status 200):

PropertyTypeRequiredDescription
itemsarray of WidgetConversationSummary*
totalinteger*

GET /api/v1/widgets/{widget_id}/analytics/messages-trend

Summary: Get Messages Trend

Get message count trend over time.

Returns time series data for charting.

Response Schema (WidgetTimeSeriesResponse - Status 200):

PropertyTypeRequiredDescription
dataarray of TimeSeriesPointResponse*
granularitystring*

GET /api/v1/widgets/{widget_id}/analytics/satisfaction-trend

Summary: Get Satisfaction Trend

Get satisfaction score trend over time.

Returns percentage of positive feedback per day.

Response Schema (WidgetTimeSeriesResponse - Status 200):

PropertyTypeRequiredDescription
dataarray of TimeSeriesPointResponse*
granularitystring*

On this page