Get Organization Analytics

See how an entire organization (company, team, etc.) engages with your AI across all their users and conversations. Spot trends, measure satisfaction, and identify opportunities to improve the experience for your biggest customers.

⚠️ Requires Growth+ plan or higher

Two modes available:

• simple mode: Get organization-wide metrics like average sentiment, frustration levels, commercial intent, and quality scores. Perfect for executive dashboards and health monitoring. No rate limiting.
• insights mode (default): Dive into detailed patterns, common topics, and AI-generated recommendations for improving this organization’s experience. Rate limited based on your plan’s maxAnalysesPerHour.

If analytics don’t exist yet, they’ll be generated in real-time from the organization’s conversations (this may take a few seconds). Returns 404 if the organization doesn’t exist or has no conversations.

GET /organizations/{organizationId}/analytics

cURL

cURL

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

200

{
  "averageUserSentiment": {
    "label": "<string>",
    "score": 123
  },
  "averageChangeInUserSentiment": {
    "label": "<string>",
    "score": 123
  },
  "averageFrustration": {
    "score": 123,
    "label": "<string>"
  },
  "averageStruggle": {
    "score": 123,
    "label": "<string>"
  },
  "averageCommercialIntent": {
    "score": 123,
    "label": "<string>"
  },
  "averageConversationRating": 123,
  "averageConversationQualityIndex": 123,
  "summary": {
    "analysis": "<string>",
    "reason": "<string>"
  },
  "totalConversations": 123,
  "topics": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "keywords": [
    {
      "name": "<string>",
      "count": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

organizationId · string<uuid> · required

The organization 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

Organization analytics retrieved successfully

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

Summary of the organization analytics.

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