EduBridge

Overview

The EduBridge client provides access to the EduBridge API, offering:

Enrollments: Simplified enrollment management
Analytics: Pre-aggregated student performance data
Subject Tracks: K-12 curriculum sequence management
Users: User management with role-based filtering
Applications: Application-level configuration
Learning Reports: Aggregated learning reports

Installation

npm install @timeback/edubridge

pnpm add @timeback/edubridge

yarn add @timeback/edubridge

bun add @timeback/edubridge

pip install timeback-edubridge

uv add timeback-edubridge

Quick Start

import { EdubridgeClient } from '@timeback/edubridge'

const client = new EdubridgeClient({
    env: 'staging',
    auth: {
        clientId: process.env.EDUBRIDGE_CLIENT_ID!,
        clientSecret: process.env.EDUBRIDGE_CLIENT_SECRET!,
    },
})

const enrollment = await client.enrollments.enroll('user-123', 'course-123')
const enrollments = await client.enrollments.list({ userId: 'user-123' })
const activity = await client.analytics.getActivity({
    studentId: 'user-123',
    startDate: '2024-01-01',
    endDate: '2024-01-31',
})

import os
from timeback_edubridge import EdubridgeClient

client = EdubridgeClient(
    env="staging",
    client_id=os.environ["EDUBRIDGE_CLIENT_ID"],
    client_secret=os.environ["EDUBRIDGE_CLIENT_SECRET"],
)

enrollment = await client.enrollments.enroll("user-123", "course-123")
enrollments = await client.enrollments.list(user_id="user-123")
activity = await client.analytics.get_activity(
    student_id="user-123",
    start_date="2024-01-01",
    end_date="2024-01-31",
)

Enrollments

Course-centric enrollment management.

client.enrollments.list({ userId })
client.enrollments.enroll(userId, courseId, schoolId?, options?)
client.enrollments.unenroll(userId, courseId, schoolId?)
client.enrollments.resetGoals(courseId)
client.enrollments.resetProgress(userId, courseId)
client.enrollments.getDefaultClass(courseId, schoolId?)

await client.enrollments.list(user_id=user_id)
await client.enrollments.enroll(user_id, course_id, school_id=..., options=...)
await client.enrollments.unenroll(user_id, course_id, school_id=...)
await client.enrollments.reset_goals(course_id)
await client.enrollments.reset_progress(user_id, course_id)
await client.enrollments.get_default_class(course_id, school_id=...)

Method	Returns	Description
`list()`	`Enrollment[]`	List enrollments for a user
`enroll()`	`Enrollment`	Enroll a user in a course
`unenroll()`	`void`	Mark the matching enrollment for deletion
`resetGoals()`	`ResetGoalsResult`	Reset goals for all users in course
`resetProgress()`	`void`	Reset a user’s progress in a course
`getDefaultClass()`	`DefaultClass`	Get the default class for a course

Analytics

Student activity data and metrics.

client.analytics.getActivity({ studentId, startDate, endDate, timezone? })
client.analytics.getWeeklyFacts({ studentId, weekDate, timezone? })
client.analytics.getEnrollmentFacts({ enrollmentId, startDate?, endDate?, timezone? })
client.analytics.getHighestGradeMastered(studentId, subject)

await client.analytics.get_activity(student_id=..., start_date=..., end_date=..., timezone=...)
await client.analytics.get_weekly_facts(student_id=..., week_date=..., timezone=...)
await client.analytics.get_enrollment_facts(enrollment_id=..., start_date=..., end_date=..., timezone=...)
await client.analytics.get_highest_grade_mastered(student_id, subject)

Method	Returns	Description
`getActivity()`	`ActivityResponse`	Activity metrics grouped by date/subject
`getWeeklyFacts()`	`WeeklyFacts`	Weekly summary for a student
`getEnrollmentFacts()`	`EnrollmentFactsResponse`	Aggregated facts for an enrollment
`getHighestGradeMastered()`	`HighestGradeMastered`	Highest grade mastered in a subject

getActivity() returns an envelope with facts and factsByApp. For TypeScript, read XP with activity.facts['2024-01-15']?.Math?.activityMetrics.xpEarned. getWeeklyFacts() returns the unwrapped facts array; getEnrollmentFacts() retains its response envelope.

Users

User filtering is exclusive: a user must have only the specified roles. listStudents() is a convenience for the student-only filter; it is not every user who also has a student role.

client.users.list({ roles, ...params })
client.users.listStudents(params?)
client.users.listTeachers(params?)
client.users.search(roles, searchTerm, limit?)

await client.users.list(roles=roles, ...)
await client.users.list_students(...)
await client.users.list_teachers(...)
await client.users.search(roles, search_term, limit=...)

Subject Tracks

K-12 curriculum sequence management.

client.subjectTracks.list()
client.subjectTracks.upsert(data)
client.subjectTracks.delete(id)
client.subjectTracks.listGroups()

await client.subject_tracks.list()
await client.subject_tracks.upsert(data)
await client.subject_tracks.delete(id)
await client.subject_tracks.list_groups()

Applications

client.applications.list()
client.applications.getMetrics(applicationSourcedId)

await client.applications.list()
await client.applications.get_metrics(application_sourced_id)

Method	Returns	Description
`list()`	`Application[]`	List all applications
`getMetrics()`	`AppMetrics`	Get metrics for an application

Learning Reports

client.learningReports.getMapProfile(userId)
client.learningReports.getTimeSaved(userId)

await client.learning_reports.get_map_profile(user_id)
await client.learning_reports.get_time_saved(user_id)

Method	Returns	Description
`getMapProfile()`	`MapProfile`	Get MAP profile for a user
`getTimeSaved()`	`TimeSaved`	Get time saved for a user

Comparison with OneRoster

Task	OneRoster	EduBridge
Enroll user	Create class, academic session, enrollment	Single `enroll()` call
Get activity	Query Caliper separately	`getActivity()` with aggregation
User search	Filter with OneRoster syntax	Role-based filtering with search
Reset progress	Manage individual gradebook results	Single `resetProgress()` call

Use EduBridge when you need simplified access to common queries. Use OneRoster when you need full control over rostering operations.

Next Steps

OneRoster

Full rostering control

Caliper

Learning event tracking

Types

EduBridge type definitions

Getting Started

CLI

SDK

Reference

Overview

Installation

Quick Start

Enrollments

Analytics

Users

Subject Tracks

Applications

Learning Reports

Comparison with OneRoster

Next Steps

OneRoster

Caliper

Types

Getting Started

CLI

SDK

Reference

​Overview

​Installation

​Quick Start

​Enrollments

​Analytics

​Users

​Subject Tracks

​Applications

​Learning Reports

​Comparison with OneRoster

​Next Steps

OneRoster

Caliper

Types

Overview

Installation

Quick Start

Enrollments

Analytics

Users

Subject Tracks

Applications

Learning Reports

Comparison with OneRoster

Next Steps