Teacher Tools Analytics API
Route: POST /api/groups/teacher-tools
Get analytics data for teacher tools usage by students within a group, including dynamic metrics based on available tool usage data with optional student-level breakdowns.
Authentication
This endpoint requires authentication using an API key. Header Required:Parameters
Query Parameters
Response Format
Group-Level Data (students=false)
Returns aggregated teacher tools analytics for the entire group.Student-Level Data (students=true)
Returns individual student teacher tools analytics.Data Fields Explained
Teacher Tools Metrics
The teacher tools endpoint returns dynamic metrics based on the specific tools being tracked. Common metrics may include:- Lesson Plans Created: Number of lesson plans generated using teacher tools
- Assignments Generated: Number of assignments created through teacher tools
- Grade Reports Accessed: Number of times grading tools were accessed
- Curriculum Tools Used: Usage count of curriculum-related tools
Additional Fields
- numStudentsUsed (Group-level only): Number of unique students who used teacher tools features
- studentName (Student-level only): Display name of the student
- studentId (Student-level only): Unique identifier for the student
Error Responses
403 Unauthorized
Returned when API key is missing or invalid.- Missing
x-api-keyheader - Invalid API key
- API key not associated with a valid group plan
400 Bad Request
Returned when required parameters are missing.Notes
- Reports are automatically sorted by start date in ascending order
- Date ranges are inclusive of both start and end dates
- All timestamps should be in ISO 8601 format
- Metrics are dynamically generated based on available teacher tools data
- If a metric doesn’t exist for a particular time period, it will show a value of 0