Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Analytics
Interactions

Get Interaction Analytics

Understand what happened in a specific conversation with AI-powered analysis. See sentiment shifts, detect frustration, identify commercial intent, and get actionable insights.

⚠️ Requires Growth+ plan or higher

Two modes available:

  • simple mode: Get just the numbers—sentiment scores, frustration levels, and key metrics. Perfect for dashboards and quick checks. No rate limiting.
  • insights mode (default): Dive deeper with detailed keywords, insights, and AI-generated suggestions for improvement. Rate limited based on your plan's maxAnalysesPerHour.

Returns 404 if the conversation doesn't exist or hasn't been analyzed yet.

get/interactions/{interactionId}/analytics

Path parameters

interactionIdstring uuid required

The interaction ID to get analytics for

The interaction ID to get analytics for

Query parameters

mode'simple' | 'insights'

Analysis mode: "simple" returns only numeric aggregates (no rate limiting), "insights" includes topics, keywords, and recommendations (rate limited per tenant plan).

Analysis mode: "simple" returns only numeric aggregates (no rate limiting), "insights" includes topics, keywords, and recommendations (rate limited per tenant plan).

Response

Interaction analytics retrieved successfully

messageCountnumber required

Number of messages in the interaction.

summarystring required

Summary of the interaction.

topicstring required

Main topic discussed.

conversationQualityIndexnumber nullable required

Quality index score for the interaction.

mostCommonUserEmotionstring required

Most common emotion expressed by user.

ratingnumber nullable required

User rating for this interaction.

keywordsstring[]

Keywords extracted (insights mode only).