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

cURL

cURL

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

200

{
  "averageUserSentiment": {
    "label": "positive",
    "score": 0.35
  },
  "averageChangeInUserSentiment": {
    "label": "stable",
    "score": 0.02
  },
  "averageFrustration": {
    "label": "low",
    "score": 0.15
  },
  "averageStruggle": {
    "label": "low",
    "score": 0.12
  },
  "averageCommercialIntent": {
    "label": "high",
    "score": 0.68
  },
  "averageConversationQualityIndex": 8.1,
  "averageConversationRating": 4.5,
  "topics": [
    {
      "name": "pricing plans",
      "count": 120
    },
    {
      "name": "feature requests",
      "count": 95
    },
    {
      "name": "integrations",
      "count": 73
    }
  ],
  "topicGroups": [
    {
      "name": "Product & Pricing",
      "count": 215
    },
    {
      "name": "Technical",
      "count": 148
    }
  ],
  "keywords": [
    {
      "name": "enterprise",
      "count": 89
    },
    {
      "name": "API",
      "count": 76
    },
    {
      "name": "upgrade",
      "count": 54
    }
  ],
  "summary": {
    "overview": "Power users show strong engagement and positive sentiment. Key interests are pricing plans and integrations.",
    "recommendations": [
      "Consider offering enterprise-tier API access to this segment.",
      "Feature request volume is high — prioritize integration docs."
    ]
  },
  "hallucinationCount": {
    "total": 3,
    "percentage": 0.4
  },
  "jailbreakCount": {
    "total": 0,
    "percentage": 0
  },
  "userBiasCount": {
    "total": 1,
    "percentage": 0.1
  },
  "modelBiasCount": {
    "total": 0,
    "percentage": 0
  },
  "userToxicityCount": {
    "total": 2,
    "percentage": 0.3
  },
  "modelToxicityCount": {
    "total": 0,
    "percentage": 0
  },
  "totalConversations": 780,
  "participantCount": 234
}

Authorizations

Authorization · string · header · required

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

Path Parameters

segmentId · string<uuid> · required

The segment ID to get analytics for.

Query Parameters

productId · string<uuid>

Filter analytics by product ID.

versionId · string<uuid>

Filter analytics by version ID.

Response

200

application/json

Segment analytics retrieved successfully

averageUserSentiment · object · required

Average sentiment across all conversations.

Show child attributes

averageChangeInUserSentiment · object · required

Average change in user sentiment.

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

topics · object[] · required

Topics discussed across conversations.

Show child attributes

topicGroups · object[] · required

Topic groups across conversations.

Show child attributes

keywords · object[] · required

Keywords extracted from conversations.

Show child attributes

summary · object · required

LLM-generated summary of the segment.

Show child attributes

hallucinationCount · object · required

Number of hallucinations detected.

Show child attributes

jailbreakCount · object · required

Number of jailbreak attempts detected.

Show child attributes

userBiasCount · object · required

Number of user bias detections.

Show child attributes

modelBiasCount · object · required

Number of model bias detections.

Show child attributes

userToxicityCount · object · required

Number of user toxicity detections.

Show child attributes

modelToxicityCount · object · required

Number of model toxicity detections.

Show child attributes

totalConversations · number · required

Total number of conversations in the segment.

participantCount · number · required

Total number of participants in the segment.

averageConversationQualityIndex · number | null

Average conversation quality index.

averageConversationRating · number | null

Average conversation rating.