Skip to main content

Classroom activity logs

Console client configuration · Response and shared models

Every activity request specifies classroomId and eduUserId. Filters include time, device, join attempt, category, and relation. Lists use cursor pagination.

tracks returns timeline tracks and overview returns the summary. Detail requests use an activity ID and the query window’s from, to, and asOf values to inspect evidence within the same window. Status, error information, and telemetry completeness fields are returned by the server.

Application backends use application business APIs with app credentials. This page describes the separate tenant management calls.

activity.list​

List classroom activity.

GET /v1/classrooms/activity

Authentication: tenant Bearer token and x-app-id.

LanguageCall
Node.jsc.activity.list(appId, input)
Pythonc.activity.list(app_id, **input)
Javac.activity.list(appId, input)
Goc.Activity.List(ctx, appID, input, &result)
PHP$c->activity->list($appId, $input)

Input: ActivityQuery. Fields are sent as URL query parameters.

FieldRequiredTypeDescription
classroomIdYesstringClassroom ID
fromNostring | undefinedRange start, ISO 8601
toNostring | undefinedRange end, ISO 8601
deviceIdNostring | undefinedDevice identifier
attemptIdNostring | undefinedJoin attempt ID
categoryNo"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefinedActivity category
relationNo"initiated" | "affected" | "observed" | "system" | "server" | undefinedUser relation to the activity
eduUserIdYesstringClassroom user ID
cursorNostring | undefinedCursor returned by the previous page
pageSizeNonumber | undefinedMaximum items per page

Returns: ActivityPage. See shared models for nested fields.

activity.tracks​

Get activity tracks.

GET /v1/classrooms/activity/tracks

Authentication: tenant Bearer token and x-app-id.

LanguageCall
Node.jsc.activity.tracks(appId, input)
Pythonc.activity.tracks(app_id, **input)
Javac.activity.tracks(appId, input)
Goc.Activity.Tracks(ctx, appID, input, &result)
PHP$c->activity->tracks($appId, $input)

Input: ActivityQuery. Fields are sent as URL query parameters.

FieldRequiredTypeDescription
classroomIdYesstringClassroom ID
fromNostring | undefinedRange start, ISO 8601
toNostring | undefinedRange end, ISO 8601
deviceIdNostring | undefinedDevice identifier
attemptIdNostring | undefinedJoin attempt ID
categoryNo"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefinedActivity category
relationNo"initiated" | "affected" | "observed" | "system" | "server" | undefinedUser relation to the activity
eduUserIdYesstringClassroom user ID
cursorNostring | undefinedCursor returned by the previous page
pageSizeNonumber | undefinedMaximum items per page

Returns: ActivityTracks. See shared models for nested fields.

activity.overview​

Get activity overview.

GET /v1/classrooms/activity/overview

Authentication: tenant Bearer token and x-app-id.

LanguageCall
Node.jsc.activity.overview(appId, input)
Pythonc.activity.overview(app_id, **input)
Javac.activity.overview(appId, input)
Goc.Activity.Overview(ctx, appID, input, &result)
PHP$c->activity->overview($appId, $input)

Input: ActivityQuery. Fields are sent as URL query parameters.

FieldRequiredTypeDescription
classroomIdYesstringClassroom ID
fromNostring | undefinedRange start, ISO 8601
toNostring | undefinedRange end, ISO 8601
deviceIdNostring | undefinedDevice identifier
attemptIdNostring | undefinedJoin attempt ID
categoryNo"join" | "stage" | "media" | "permission" | "message" | "whiteboard" | "tool" | "connection" | "lifecycle" | "other" | undefinedActivity category
relationNo"initiated" | "affected" | "observed" | "system" | "server" | undefinedUser relation to the activity
eduUserIdYesstringClassroom user ID
cursorNostring | undefinedCursor returned by the previous page
pageSizeNonumber | undefinedMaximum items per page

Returns: ActivityOverview. See shared models for nested fields.

activity.detail​

Get activity detail.

GET /v1/classrooms/activity/detail

Authentication: tenant Bearer token and x-app-id.

LanguageCall
Node.jsc.activity.detail(appId, input)
Pythonc.activity.detail(app_id, **input)
Javac.activity.detail(appId, input)
Goc.Activity.Detail(ctx, appID, input, &result)
PHP$c->activity->detail($appId, $input)

Input: ActivityDetailInput. Fields are sent as URL query parameters.

FieldRequiredTypeDescription
classroomIdYesstringClassroom ID
fromYesstringRange start, ISO 8601
toYesstringRange end, ISO 8601
asOfYesstringObservation cutoff returned by the list
eduUserIdYesstringClassroom user ID
activityIdYesstringActivity ID
cursorNostring | undefinedCursor returned by the previous page
pageSizeNonumber | undefinedMaximum items per page

Returns: ActivityDetail. See shared models for nested fields.