Skip to main content
GET
/
api
/
v1
/
usage-analyst
/
events
Get all events based on filters
const url = 'https://studyfetchapi.com/api/v1/usage-analyst/events';
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);
}

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
eventType
enum<string>
required

Type of usage event to filter

Available options:
material_created,
material_uploaded,
material_processed,
material_deleted,
component_created,
component_accessed,
component_deleted,
component_usage,
chat_message_sent,
chat_session_started,
chat_session_ended,
chat_feedback,
test_created,
test_started,
test_completed,
test_question_answered,
test_retaken,
audio_recap_create,
assignment_grader_create,
api_call,
cache_hit,
sso_login,
sso_logout,
student_performance
​
startDate
string
required

Start date for filtering (ISO 8601)

​
endDate
string
required

End date for filtering (ISO 8601)

​
userIds
string[]

Array of user IDs to filter

Example:
["user123", "user456"]
​
groupIds
string[]

Array of group IDs to filter

Example:
["class-101", "class-102"]

Response

200

Events retrieved successfully

⌘I