sdk.hunt_analytics

@type library Authoritative hunt/session analytics. The service consumes typed protocol events and (optionally) terminal action-broker snapshots. It never parses chat text and never sends telemetry over the network.

local M = require("sdk.hunt_analytics")

Constants

Lua 5.4 has no enums — these are integer (or string) fields on the module.

Name	Value	Summary
Service	Service	Hunt analytics class.

new

function · new(opts)

Create a hunt analytics recorder.

start

function · start(...) return default_service():start(...)

Start the default analytics session.

stop

function · stop(...) return default_service():stop(...)

Stop the default analytics session.

finish

function · finish(...) return default_service():finish(...)

Finish and persist the default session.

reset

function · reset(...) return default_service():reset(...)

Clear the default analytics state.

handle

function · handle(...) return default_service():handle(...)

Feed an event into the default recorder.

record

function · record(...) return default_service():record(...)

Record one analytics sample.

poll

function · poll(...) return default_service():poll(...)

Drain finished analytics payloads.

snapshot

function · snapshot(...) return default_service():snapshot(...)

Current hunt analytics snapshot.

summary

function · summary(...) return default_service():summary(...)

Rolled-up hunt summary.

is_active

function · is_active() return default_service():is_active()

True while a hunt session is recording.

is_started

function · is_started() return default_service():is_started()

True after start and before finish.

isSessionActive

alias · isSessionActive = is_active

Familiar analyzer aliases for scripts migrating from older bot APIs.

Alias

Same as is_active.

getMetrics

alias · getMetrics = snapshot

Same as snapshot.

Alias

Same as snapshot.

buildSummary

alias · buildSummary = summary

Same as summary.

Alias

Same as summary.