Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
days
integer<int32>

time window: 7, 14, 30, 90

timezone
string | null

IANA timezone (e.g. "America/New_York") used to bucket the usage heatmap by the viewer's local weekday/hour. Falls back to UTC when unset/invalid.

Response

Success

summary
summary · object
dailyVolume
DailyVolumePoint · object[]
warningDistribution
WarningTypeCount · object[]
warningCatalog
WarningTypeMeta · object[]
warningDailyDistribution
WarningTypeDailyCount · object[]

Per-day, per-type warning counts for the warning-breakdown-over-time chart. Days/types with no warnings are absent (the client zero-fills the axis).

usageHeatmap
UsageHeatmapPoint · object[]

Chat counts bucketed by weekday x hour-of-day (in the request timezone, UTC default) for the usage heatmap. Empty buckets are absent (the client zero-fills the 7x24 grid).