GET
/
api
/
v1
/
usage
/
events
Get usage events
const url = 'https://studyfetchapi.com/api/v1/usage/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

startDate
string

Start date for filtering (ISO 8601)

endDate
string

End date for filtering (ISO 8601)

eventType
enum<string>

Filter by event type

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,
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
userId
string

Filter by user ID

groupId
string

Filter by group ID

resourceId
string

Filter by resource ID

limit
number
default:100

Number of results to return

Required range: 1 <= x <= 1000
offset
number
default:0

Offset for pagination

Required range: x >= 0

Response

200

Usage events retrieved