/** * Analytics Resource * * Student activity data and metrics. */ import type { ActivityParams, EnrollmentFactsParams, WeeklyFactsParams } from '@timeback/types/zod'; import type { ActivityResponse, EdubridgeTransportLike, EnrollmentFactsResponse, HighestGradeMastered, WeeklyFacts } from '../types'; /** * Analytics resource for retrieving student activity data. * * Provides access to activity metrics, weekly facts, and grade mastery data. */ export declare class AnalyticsResource { private readonly transport; constructor(transport: EdubridgeTransportLike); /** * Get activity data for a date range. * * Returns metrics grouped by date, then by subject. * Accepts dates in YYYY-MM-DD or full ISO 8601 format. * * Bare dates are expanded to cover the full day. When `timezone` is provided, * day boundaries are computed in that timezone before conversion to UTC. * * @param params - Query parameters including email or studentId, startDate, endDate * @returns Full activity response including `facts` and `factsByApp` */ getActivity(params: ActivityParams): Promise; /** * Get weekly facts for a student. * * Returns individual facts grouped by date for a specific week. * Accepts weekDate in YYYY-MM-DD or full ISO 8601 format. * * @param params - Query parameters including email or studentId and weekDate * @returns Weekly facts data */ getWeeklyFacts(params: WeeklyFactsParams): Promise; /** * Get aggregated facts for an enrollment. * * Returns aggregated metrics for all activity within an enrollment. * Accepts dates in YYYY-MM-DD or full ISO 8601 format. * * @param params - Query parameters including enrollmentId and optional date filters * @returns Full enrollment facts response including `facts` and `factsByApp` */ getEnrollmentFacts(params: EnrollmentFactsParams): Promise; /** * Get the highest grade a student has mastered for a subject. * * Returns grade data from multiple sources (Edulastic, placement tests, test-out). * * @param studentId - Student ID * @param subject - Subject name * @returns Highest grade mastered data */ getHighestGradeMastered(studentId: string, subject: string): Promise; } //# sourceMappingURL=analytics.d.ts.map