InsightTypeOutput

Registered insight type with metadata

  • category
    Type: string
    required

    Category name. Supported categories are AcademicIntegrity, Observability, OnlineEnvironment and PhysicalEnvironment; Engagement, Proctoring and Cheating are deprecated.

  • color
    Type: string | null
    required

    Hex color string (e.g.,

  • deprecated
    Type: boolean
    required

    The type is no longer recommended for new integrations

  • description
    Type: string | null
    required

    Human-readable description for tooltips in consumer UIs

  • detectionSources
    Type: array of stringenum
    required

    Semantic medium(s) analyzed to mine this insight type. Empty means no known medium dependency.

    values
    webcamaudioscreenclientdomnetworkapp_events
  • displayName
    Type: string
    required

    Human-readable display name

  • id
    Type: stringFormat: uuid
    required

    Unique identifier

  • insightGroup
    Type: string | null
    required

    Stable Insight Group slug for the healthy habit or rule this type belongs to. The published set is served by GET /signals/1.0/insights/groups; it is not a fixed list. Null only for record types that describe no behaviour (for example, Journal).

  • isContinuous
    Type: boolean
    required

    Whether this type supports continuous gap-based merging

  • isWaste
    Type: boolean
    required

    Whether this type counts toward waste duration calculations

  • precedenceLevel
    Type: integer | null
    required

    Precedence level for waste overlap resolution (1=highest, 5=lowest, null=not applicable)

  • slug
    Type: string
    required

    PascalCase slug (e.g., AwayFromSeat)

  • sunsetAt
    Type: string | nullFormat: date-time
    required

    When the type will leave the catalog. Null until a removal date is committed.

  • triggersInSessionNotification
    Type: boolean
    required

    Whether instances of this insight type should surface as in-session notifications to the student

  • visibility
    Type: "external" or "internal"enum
    required

    Whether this type is visible to all callers or internal callers only

  • audience
    Type: string | nullenum

    Who the type is written for. Null for types outside the v1 catalog.

    values
    StudentGuideAppOwnerSafetyInternal
  • latency
    Type: "Live" or "Session end" or "Next day"enum

    When an occurrence is expected to be available after it happens. Null for types outside the v1 catalog.

  • scope
    Type: "Test window" or "Learning" or "All sessions"enum

    Which sessions the type covers. Test window means only proctored test time; Learning means ordinary study; All sessions means both. Null for types outside the v1 catalog.

Previous
InsightType
Next
InsightVersion