v28

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

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

Path parameters

organizationIdstring uuid required

The organization ID to get analytics for

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

Organization analytics retrieved successfully

averageConversationRatingnumber nullable required

Average conversation rating.

averageConversationQualityIndexnumber nullable required

Average conversation quality index.

totalConversationsnumber required

Total number of conversations analyzed.