> ## 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.

# List insight types

> Retrieve all active registered insight types visible to the authenticated caller, optionally filtered by category. Membership is global and does not vary by organization. External callers receive only `visibility=external` types; internal callers receive active internal and external types. Locale message bundles and organization policy are not part of this endpoint. Waste Meter consumers select entries with `isWaste=true` from this response. Catalog reads are cached in-process for up to 10 minutes; registry changes become visible across warm Lambda containers within that bound.



## OpenAPI

````yaml /openapi/learn-with-ai/platform-api.yaml get /insights/1.0/types
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/types:
    get:
      tags:
        - Insights
      summary: List insight types
      description: >-
        Retrieve all active registered insight types visible to the
        authenticated caller, optionally filtered by category. Membership is
        global and does not vary by organization. External callers receive only
        `visibility=external` types; internal callers receive active internal
        and external types. Locale message bundles and organization policy are
        not part of this endpoint. Waste Meter consumers select entries with
        `isWaste=true` from this response. Catalog reads are cached in-process
        for up to 10 minutes; registry changes become visible across warm Lambda
        containers within that bound.
      operationId: getInsightTypes
      parameters:
        - name: category
          in: query
          description: >-
            Filter by category. Supported categories are AcademicIntegrity,
            Observability, OnlineEnvironment and PhysicalEnvironment;
            Engagement, Proctoring and Cheating are deprecated.
          required: false
          schema:
            type: string
            examples:
              - >-
                AcademicIntegrity,Observability,OnlineEnvironment,PhysicalEnvironment
        - $ref: '#/components/parameters/insightGroups'
      responses:
        '200':
          description: Successful response with insight types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InsightTypeOutput'
        '400':
          $ref: '#/components/responses/BadRequest18'
        '401':
          $ref: '#/components/responses/Unauthorized8'
        '403':
          $ref: '#/components/responses/Forbidden7'
        '500':
          $ref: '#/components/responses/InternalError18'
      security:
        - CognitoUserPoolAuthorizer:
            - https://purl.imsglobal.org/spec/caliper/v1p2/scope/events.readonly
components:
  parameters:
    insightGroups:
      name: insightGroups
      in: query
      description: >-
        Comma-separated list of stable Insight Group slugs to filter by. Display
        names are served by GET /insights/1.0/insight-groups. Takes precedence
        over category and default, but is overridden by type (or insightTypes on
        session endpoints). On endpoints that return insights, selects matching
        insights. On endpoints that return sessions, a session is returned only
        if it carries at least one caller-visible insight of a member type, and
        the session's metrics scope to the filter.
      required: false
      schema:
        type: string
        examples:
          - StayFocused,DistractionFreeSpace
      style: form
      explode: false
  schemas:
    InsightTypeOutput:
      type: object
      description: Registered insight type with metadata
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier
        slug:
          type: string
          description: PascalCase slug (e.g., AwayFromSeat)
        displayName:
          type: string
          description: Human-readable display name
        category:
          type: string
          description: >-
            Category name. Supported categories are AcademicIntegrity,
            Observability, OnlineEnvironment and PhysicalEnvironment;
            Engagement, Proctoring and Cheating are deprecated.
        visibility:
          type: string
          enum:
            - external
            - internal
          description: Whether this type is visible to all callers or internal callers only
        isContinuous:
          type: boolean
          description: Whether this type supports continuous gap-based merging
        precedenceLevel:
          type:
            - integer
            - 'null'
          description: >-
            Precedence level for waste overlap resolution (1=highest, 5=lowest,
            null=not applicable)
        isWaste:
          type: boolean
          description: Whether this type counts toward waste duration calculations
        description:
          type:
            - string
            - 'null'
          description: Human-readable description for tooltips in consumer UIs
        color:
          type:
            - string
            - 'null'
          description: Hex color string (e.g.,
        triggersInSessionNotification:
          type: boolean
          description: >-
            Whether instances of this insight type should surface as in-session
            notifications to the student
        detectionSources:
          type: array
          description: >-
            Semantic medium(s) analyzed to mine this insight type. Empty means
            no known medium dependency.
          items:
            type: string
            enum:
              - webcam
              - screen
              - client
              - dom
              - network
              - app_events
        insightGroup:
          type:
            - string
            - 'null'
          description: >-
            Stable Insight Group slug for the healthy habit or rule this type
            belongs to. The published set is served by GET
            /insights/1.0/insight-groups; it is not a fixed list. Null only for
            record types that describe no behaviour (for example, Journal).
          examples:
            - StayFocused
        deprecated:
          type: boolean
          default: false
          description: The type is no longer recommended for new integrations
        sunsetAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the type will leave the catalog. Null until a removal date is
            committed.
      required:
        - id
        - slug
        - displayName
        - category
        - visibility
        - isContinuous
        - precedenceLevel
        - isWaste
        - description
        - color
        - triggersInSessionNotification
        - detectionSources
        - insightGroup
        - deprecated
        - sunsetAt
    ApiError:
      type: object
      description: API error response
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Error message
      required:
        - error
        - message
  responses:
    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
    InternalError18:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            default:
              value:
                error: Internal server error
                message: Internal server error
  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

````