Skip to main content
GET
/
api
/
v1
/
chat-analytics
/
analyze
Get chat analytics and user statistics
const url = 'https://studyfetchapi.com/api/v1/chat-analytics/analyze';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "summary": {
    "summary": "<string>",
    "totalUsers": 123,
    "totalSessions": 123,
    "totalMessages": 123,
    "topTopics": [
      "<string>"
    ],
    "averageMessagesPerUser": 123,
    "engagement": {},
    "overallAveragePromptingScore": 123,
    "overallAverageResponsibilityScore": 123,
    "overallPromptingDistribution": {},
    "overallResponsibilityDistribution": {}
  },
  "userStats": [
    {
      "userId": "<string>",
      "email": "<string>",
      "name": "<string>",
      "totalMessages": 123,
      "totalSessions": 123,
      "averageMessagesPerSession": 123,
      "topTopics": [
        "<string>"
      ],
      "lastActive": "2023-11-07T05:31:56Z",
      "firstActive": "2023-11-07T05:31:56Z",
      "averageSessionDuration": 123,
      "groupIds": [
        "<string>"
      ],
      "averagePromptingScore": 123,
      "averageResponsibilityScore": 123,
      "totalGradedMessages": 123,
      "promptingDistribution": {},
      "responsibilityDistribution": {}
    }
  ],
  "generatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API Key for authentication

Query Parameters

componentId
string

Component ID to analyze

organizationId
string

Organization ID to filter by

userId
string

User ID to filter by

groupIds
string[]

Group IDs to filter by

startDate
string<date-time>

Start date for analysis

endDate
string<date-time>

End date for analysis

modelKey
string

AI model to use for analysis

Example:

"gpt-4o-mini"

Response

200 - application/json

Chat analytics data

summary
object
required

Analytics summary

userStats
object[]
required

User statistics

generatedAt
string<date-time>
required

Date when analytics were generated

I