Get Segment Analytics

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

import os
from greenflash import Greenflash

client = Greenflash(
    api_key=os.environ.get("GREENFLASH_API_KEY"),  # This is the default and can be omitted
)
get_segment_analytics_response = client.segments.get_segment_analytics(
    segment_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(get_segment_analytics_response.average_change_in_user_sentiment)

import Greenflash from 'greenflash';

const client = new Greenflash({
  apiKey: process.env['GREENFLASH_API_KEY'], // This is the default and can be omitted
});

const getSegmentAnalyticsResponse = await client.segments.getSegmentAnalytics(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(getSegmentAnalyticsResponse.averageChangeInUserSentiment);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.greenflash.ai/api/v1/segments/{segmentId}/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://www.greenflash.ai/api/v1/segments/{segmentId}/analytics")
  .header("Authorization", "Bearer <token>")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.greenflash.ai/api/v1/segments/{segmentId}/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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
}

{
  "success": false,
  "error": "This endpoint requires a Growth plan or higher"
}

{
  "success": false,
  "error": "Segment not found"
}

{
  "success": false,
  "error": "Rate limit exceeded for analytics requests. Please try again later."
}

{
  "success": true,
  "error": "<string>"
}