v28

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

Analytics

Segments

Get Segment Analytics

Get aggregated analytics for a specific segment including sentiment, safety metrics, topics, keywords, and an LLM-generated summary.

Requires Growth+ plan or higher.

Rate limited based on your plan's maxAnalysesPerHour. Cached results (less than 2 hours old) do not consume rate limit points.

get/segments/{segmentId}/analytics

segmentIdstring uuid required

The segment ID to get analytics for.

productIdstring uuid

Filter analytics by product ID.

versionIdstring uuid

Filter analytics by version ID.

Segment analytics retrieved successfully

averageConversationQualityIndexnumber nullable

Average conversation quality index.

averageConversationRatingnumber nullable

Average conversation rating.

summaryobject nullable required

LLM-generated summary of the segment.

totalConversationsnumber required

Total number of conversations in the segment.

participantCountnumber required

Total number of participants in the segment.