Get Model Analytics

curl --request GET \
  --url https://www.greenflash.ai/api/v1/models/{modelId}/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_model_analytics_response = client.models.get_model_analytics(
    model_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(get_model_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 getModelAnalyticsResponse = await client.models.getModelAnalytics(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(getModelAnalyticsResponse.averageChangeInUserSentiment);

package main

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

func main() {

	url := "https://www.greenflash.ai/api/v1/models/{modelId}/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/models/{modelId}/analytics")
  .header("Authorization", "Bearer <token>")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.greenflash.ai/api/v1/models/{modelId}/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;
}

{
  "avgConversationQualityIndex": 7.8,
  "avgSatisfactionScore": 0.82,
  "avgGrowthScore": 0.65,
  "avgFrictionScore": 0.88,
  "avgSafetyScore": 0.94,
  "averageUserSentiment": {
    "label": "positive",
    "score": 0.28
  },
  "averageChangeInUserSentiment": {
    "label": "stable",
    "score": 0.03
  },
  "averageFrustration": {
    "label": "low",
    "score": 0.18
  },
  "averageStruggle": {
    "label": "low",
    "score": 0.14
  },
  "averageCommercialIntent": {
    "label": "moderate",
    "score": 0.42
  },
  "hallucinationCount": {
    "total": 8,
    "percentage": 0.9
  },
  "jailbreakCount": {
    "total": 2,
    "percentage": 0.2
  },
  "userBiasCount": {
    "total": 1,
    "percentage": 0.1
  },
  "modelBiasCount": {
    "total": 3,
    "percentage": 0.3
  },
  "userToxicityCount": {
    "total": 4,
    "percentage": 0.4
  },
  "modelToxicityCount": {
    "total": 0,
    "percentage": 0
  },
  "recommendations": {
    "summary": "GPT-4o is performing well overall. Hallucination rate is slightly elevated for refund policy topics.",
    "healthLevel": "healthy",
    "strengths": [
      "High satisfaction scores across all products",
      "Excellent safety compliance",
      "Low friction in multi-turn conversations"
    ],
    "recommendations": [
      {
        "title": "Reduce hallucination in billing topics",
        "action": "Add explicit billing policy context to the system prompt",
        "rationale": {
          "whyThisMatters": "Billing hallucinations erode customer trust.",
          "observedPattern": "65% of hallucinations occur in refund/billing conversations.",
          "tradeoff": "Longer system prompt may slightly increase latency."
        },
        "evidence": {
          "exampleSnippets": [
            "Bot stated \"refunds are processed in 24 hours\" when policy says 5-7 business days."
          ]
        },
        "expectedImpact": [
          "Reduce hallucination rate by ~40%",
          "Improve billing conversation CQI from 6.2 to 7.5+"
        ],
        "priority": "high",
        "category": "prompt_optimization_link"
      }
    ],
    "detectedIssues": [
      {
        "id": "hallucination-billing",
        "severity": "warning",
        "title": "Elevated hallucination rate in billing-related conversations"
      }
    ]
  },
  "conversationCount": 4520,
  "messageCount": 31640,
  "averageConversationRating": 4.2,
  "dataPoints": [
    {
      "date": "2025-10-01T00:00:00Z",
      "avgConversationQualityIndex": 7.6,
      "avgSatisfactionScore": 0.8,
      "avgGrowthScore": 0.63,
      "avgFrictionScore": 0.86,
      "avgSafetyScore": 0.93,
      "conversationCount": 152,
      "messageCount": 1064
    },
    {
      "date": "2025-10-08T00:00:00Z",
      "avgConversationQualityIndex": 7.9,
      "avgSatisfactionScore": 0.83,
      "avgGrowthScore": 0.66,
      "avgFrictionScore": 0.89,
      "avgSafetyScore": 0.95,
      "conversationCount": 168,
      "messageCount": 1176
    }
  ]
}

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

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

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

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