Skip to main content
GET
List insight types

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Query Parameters

category
string

Filter by category. Supported categories are AcademicIntegrity, Observability, OnlineEnvironment and PhysicalEnvironment; Engagement, Proctoring and Cheating are deprecated.

Example:

"AcademicIntegrity,Observability,OnlineEnvironment,PhysicalEnvironment"

insightGroups
string

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.

Example:

"StayFocused,DistractionFreeSpace"

Response

Successful response with insight types

id
string<uuid>
required

Unique identifier

slug
string
required

PascalCase slug (e.g., AwayFromSeat)

displayName
string
required

Human-readable display name

category
string
required

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

visibility
enum<string>
required

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

Available options:
external,
internal
isContinuous
boolean
required

Whether this type supports continuous gap-based merging

precedenceLevel
integer | null
required

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

isWaste
boolean
required

Whether this type counts toward waste duration calculations

description
string | null
required

Human-readable description for tooltips in consumer UIs

color
string | null
required

Hex color string (e.g.,

triggersInSessionNotification
boolean
required

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

detectionSources
enum<string>[]
required

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

Available options:
webcam,
screen,
client,
dom,
network,
app_events
insightGroup
string | null
required

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

Example:

"StayFocused"

deprecated
boolean
default:false
required

The type is no longer recommended for new integrations

sunsetAt
string<date-time> | null
required

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