> ## Documentation Index > Fetch the complete documentation index at: https://docs.timeback.com/llms.txt > Use this file to discover all available pages before exploring further. # Get user insights overview > Retrieve aggregated overview (trend and breakdown) for a user within a date range ## OpenAPI ````yaml /openapi/learn-with-ai/platform-api.yaml get /insights/1.0/users/{userId}/overview openapi: 3.1.1 info: title: TimeBack Platform API description: >- RESTful API for the TimeBack Platform. Covers authentication, rostering, curriculum, insights, assessments, content grading, and more. version: 2026.09.10.1 servers: - url: https://platform.dev.timeback.com description: integration security: [] tags: - name: Auth description: Authentication and authorization endpoints - name: Organizations description: Organizations module contains all endpoints around organization management - name: Applications description: Applications module contains all endpoints for managing LTI applications - name: Users description: >- Users module contains all endpoints around user creation, update and consultation - name: Students description: Students module contains all endpoints around student management - name: Demographics description: >- Demographics module contains all endpoints around demographics consultation - name: Consent description: >- Initiate and query TimeBack parental consent for a student, backed by an immutable audit trail. - name: Classes description: Classes module contains all endpoints around class management - name: Courses description: Courses module contains all endpoints around course management - name: Enrollments description: Enrollments module contains all endpoints around enrollment consultation - name: CASE description: Competency and Academic Standards Exchange (CASE) 1.1 API - name: Curriculum description: Curriculum module contains endpoints for managing curriculum data - name: Competency Track description: Competency track endpoints - name: Content Grading description: >- Registration and management of graders for free-response content items — bring-your-own external graders (Tier 2) and, once shipped, platform-managed grading prompts (Tier 1). - name: Caliper description: The Caliper module contains all endpoints around Caliper Analytics - name: Insights description: Coaching insights and session analytics endpoints paths: /insights/1.0/users/{userId}/overview: get: tags: - Insights summary: Get user insights overview description: >- Retrieve aggregated overview (trend and breakdown) for a user within a date range operationId: getUserInsightsOverview parameters: - name: userId in: path description: User ID to retrieve overview for required: true schema: type: string format: uuid - name: applicationId in: query description: >- Optional application ID to scope the overview to a specific application required: false schema: type: string format: uuid - name: startedAfter in: query description: Lower bound (inclusive) for time window (ISO 8601 date-time) required: true schema: type: string format: date-time - name: startedBefore in: query description: Upper bound (exclusive) for time window (ISO 8601 date-time) required: true schema: type: string format: date-time - name: targetTimezone in: query description: IANA timezone name for local-day bucketing (e.g., Asia/Karachi) required: true schema: type: string responses: '200': $ref: '#/components/responses/InsightsOverviewSuccess' '400': $ref: '#/components/responses/BadRequest18' '401': $ref: '#/components/responses/Unauthorized8' '403': $ref: '#/components/responses/Forbidden7' '404': $ref: '#/components/responses/NotFound9' '500': $ref: '#/components/responses/InternalError18' security: - CognitoUserPoolAuthorizer: - https://purl.imsglobal.org/spec/caliper/v1p2/scope/events.readonly components: responses: InsightsOverviewSuccess: description: Successful response with overview data content: application/json: schema: $ref: '#/components/schemas/GetUserInsightsOverviewOutput' BadRequest18: description: Bad request content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: default: value: error: Bad request message: Invalid request parameters Unauthorized8: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: default: value: error: Unauthorized request message: Unauthorized request Forbidden7: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: default: value: error: Access forbidden message: Access forbidden NotFound9: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: default: value: error: Object not found message: Object with ID {id} not found InternalError18: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: default: value: error: Internal server error message: Internal server error schemas: GetUserInsightsOverviewOutput: type: object properties: summary: type: object properties: totalDurationInSeconds: type: integer totalWasteDurationInSeconds: type: integer wastePercentage: type: integer biggestInsight: allOf: - $ref: '#/components/schemas/InsightsBiggestInsight' - nullable: true required: - totalDurationInSeconds - totalWasteDurationInSeconds - wastePercentage - biggestInsight trend: type: object properties: buckets: type: array items: $ref: '#/components/schemas/InsightsTrendBucket' required: - buckets breakdown: type: object properties: levels: type: array items: $ref: '#/components/schemas/InsightsLevelBreakdown' required: - levels required: - summary - trend - breakdown ApiError: type: object description: API error response properties: error: type: string description: Error type message: type: string description: Error message required: - error - message InsightsBiggestInsight: type: object properties: level: $ref: '#/components/schemas/InsightsOverviewLevel' durationInSeconds: type: integer minimum: 0 wastePercentage: type: integer minimum: 0 maximum: 100 required: - level - durationInSeconds - wastePercentage InsightsTrendBucket: type: object properties: startedAtTime: type: string format: date-time endedAtTime: type: string format: date-time totalDurationInSeconds: type: integer minimum: 0 wasteDurationInSeconds: type: integer minimum: 0 wastePercentage: type: integer minimum: 0 maximum: 100 levels: type: array items: $ref: '#/components/schemas/InsightsLevelSegment' required: - startedAtTime - endedAtTime - totalDurationInSeconds - wasteDurationInSeconds - wastePercentage - levels InsightsLevelBreakdown: type: object properties: level: $ref: '#/components/schemas/InsightsOverviewLevel' durationInSeconds: type: integer minimum: 0 wastePercentage: type: integer minimum: 0 maximum: 100 subtypes: type: array items: $ref: '#/components/schemas/InsightsSubtypeSegment' required: - level - durationInSeconds - wastePercentage - subtypes InsightsOverviewLevel: type: string enum: - StudentNotPresent - FocusAndIntensity - EnvironmentalDistractions - OnDeviceDistractions - LearningAppBestPractices - Unclassified InsightsLevelSegment: type: object properties: level: $ref: '#/components/schemas/InsightsOverviewLevel' durationInSeconds: type: integer minimum: 0 required: - level - durationInSeconds InsightsSubtypeSegment: type: object properties: insightType: $ref: '#/components/schemas/InsightType' durationInSeconds: type: integer minimum: 0 required: - insightType - durationInSeconds InsightType: type: string description: >- Insight type slug (data-driven, see GET /insights/1.0/types for available types) securitySchemes: CognitoUserPoolAuthorizer: type: oauth2 description: >- OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application. flows: clientCredentials: tokenUrl: https://platform.dev.timeback.com/auth/1.0/token scopes: https://purl.imsglobal.org/spec/or/v1p2/scope/roster.readonly: roster readonly https://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.readonly: roster-core readonly https://purl.imsglobal.org/spec/or/v1p2/scope/roster.createput: roster createput https://purl.imsglobal.org/spec/lti/v1p3/scope/lti.readonly: lti readonly https://purl.imsglobal.org/spec/or/v1p2/scope/roster-demographics.readonly: roster-demographics readonly https://timeback-platform.trilogy.com/consent/scope/consent.write: consent write https://timeback-platform.trilogy.com/consent/scope/consent.read: consent read https://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.createput: roster-core createput https://purl.imsglobal.org/spec/or/v1p2/scope/roster.delete: roster delete https://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.delete: roster-core delete https://purl.imsglobal.org/spec/case/v1p0/scope/case.readonly: case readonly https://purl.imsglobal.org/spec/case/v1p0/scope/case.createput: case createput https://purl.imsglobal.org/spec/case/v1p0/scope/case.delete: case delete https://timeback-platform.trilogy.com/competency-track/scope/competency-track.readonly: competency-track readonly https://timeback-platform.trilogy.com/competency-track/scope/competency-track.write: competency-track write https://timeback-platform.trilogy.com/competency-track/scope/competency-track.delete: competency-track delete https://timeback-platform.trilogy.com/content/scope/content.write: content write https://timeback-platform.trilogy.com/content/scope/content.read: content read https://purl.imsglobal.org/spec/caliper/v1p2/scope/events.write: events write https://purl.imsglobal.org/spec/caliper/v1p2/scope/events.readonly: events readonly https://timeback-platform.trilogy.com/webhooks/scope/webhooks.write: webhooks write https://timeback-platform.trilogy.com/webhooks/scope/webhooks.read: webhooks read https://timeback-platform.trilogy.com/webhooks/scope/webhooks.delete: webhooks delete ````