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

cURL

cURL

curl --request GET \
  --url https://www.greenflash.ai/api/v1/users/{userId}/analytics \
  --header 'Authorization: Bearer <token>'

200

{
  "averageSentiment": {
    "label": "neutral",
    "score": 0.05
  },
  "averageFrustration": {
    "label": "moderate",
    "score": 0.38
  },
  "averageStruggle": {
    "label": "low",
    "score": 0.2
  },
  "conversationCount": 47,
  "averageQualityIndex": 6.8,
  "topTopics": [
    {
      "name": "billing",
      "count": 15
    },
    {
      "name": "account access",
      "count": 12
    },
    {
      "name": "feature questions",
      "count": 8
    }
  ],
  "lastConversationAt": "2025-10-14T16:22:00Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string<uuid> · required

The user ID to get analytics for

Query Parameters

mode · enum<string> · default: insights

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

Available options: simple, insights

productId · string<uuid>

Filter analytics by product ID.

versionId · string<uuid>

Filter analytics by version ID.

Response

200

application/json

User analytics retrieved

averageUserSentiment · object · required

Average sentiment across all conversations.

Show child attributes

averageChangeInUserSentiment · object · required

Distribution of sentiment changes.

Show child attributes

averageFrustration · object · required

Average frustration level.

Show child attributes

averageStruggle · object · required

Average struggle level.

Show child attributes

averageCommercialIntent · object · required

Average commercial intent.

Show child attributes

averageConversationRating · number | null · required

Average conversation rating.

averageConversationQualityIndex · number | null · required

Average conversation quality index.

summary · object · required

Structured participant profile summary.

Show child attributes

totalConversations · number · required

Total number of conversations analyzed.

topics · object[]

Topics discussed (insights mode only).

Show child attributes

keywords · object[]

Keywords extracted (insights mode only).

Show child attributes