Sign in

v28

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

Get User Analytics

Understand how a specific user engages with your AI across all their conversations. Track their satisfaction, identify pain points, and spot opportunities to improve their experience.

⚠️ Requires Growth+ plan or higher

Two modes available:

  • simple mode: Get aggregate metrics like average sentiment, frustration levels, and conversation quality. Perfect for user dashboards. No rate limiting.
  • insights mode (default): Access detailed patterns, recurring topics, and AI-generated recommendations specific to this user. Rate limited based on your plan's maxAnalysesPerHour.

Returns 404 if the user doesn't exist or has no conversations yet.

get/users/{userId}/analytics

Path parameters

userIdstring uuid required

The user ID to get analytics for

The user 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).

productIdstring uuid

Filter analytics by product ID.

Filter analytics by product ID.

versionIdstring uuid

Filter analytics by version ID.

Filter analytics by version ID.

Response

User analytics retrieved

averageConversationRatingnumber nullable required

Average conversation rating.

averageConversationQualityIndexnumber nullable required

Average conversation quality index.

totalConversationsnumber required

Total number of conversations analyzed.