JavaScript
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}}; fetch('https://studyfetchapi.com/api/v1/chat-analytics/component/{componentId}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
{ "summary": { "summary": "<string>", "totalUsers": 123, "totalSessions": 123, "totalMessages": 123, "topTopics": [ "<string>" ], "averageMessagesPerUser": 123, "engagement": {}, "overallAveragePromptingScore": 123, "overallAverageResponsibilityScore": 123, "overallPromptingDistribution": {}, "overallResponsibilityDistribution": {} }, "userStats": [ { "userId": "<string>", "totalMessages": 123, "totalSessions": 123, "averageMessagesPerSession": 123, "topTopics": [ "<string>" ], "lastActive": "2023-11-07T05:31:56Z", "firstActive": "2023-11-07T05:31:56Z", "averageSessionDuration": 123, "email": "<string>", "name": "<string>", "groupIds": [ "<string>" ], "averagePromptingScore": 123, "averageResponsibilityScore": 123, "totalGradedMessages": 123, "promptingDistribution": {}, "responsibilityDistribution": {} } ], "generatedAt": "2023-11-07T05:31:56Z" }
API Key for authentication
Component ID
Organization ID to filter by
User ID to filter by
Group IDs to filter by
Start date for analysis
End date for analysis
AI model to use for analysis
"gpt-4o-mini"
Component-specific chat analytics
Analytics summary
Show child attributes
User statistics
Date when analytics were generated
Was this page helpful?