Skip to main content

Properties

string[]
Query parameter names to keep in captured URLs. Defaults to none.
string
required
The publishable ingest key from Hinto.
string
The Hinto API origin. Defaults to https://api.gethinto.com.
string
Your release, such as a commit SHA. Stored on each session so investigations know the build.
boolean
Record clicks with the element’s role and label. Defaults to true.
ConsoleLevel[]
Type: ConsoleLevelConsole levels to record. Defaults to ["warn", "error"]; [] records none.
boolean
Record each fetch and XHR request’s method, redacted URL, status, and duration. Defaults to true.
boolean
Record how far the customer scrolled. Defaults to true.
boolean | (message: string, details: unknown) => void
true logs [Hinto] warnings to the console; a function receives each line instead.
string
Your deployment name, such as production or preview. Stored on each session.
number
Milliseconds between sends. Defaults to 5000.
string
A full ingest endpoint, when it is not ${apiUrl}/v1/ingest.
{ kind: "external_id"; value: string }
The signed-in customer’s id from the first event. Journeys and Native Support need it.
number
Most events in one send.
number
Most bytes in one send while the page hides or unloads.
number
Most bytes in one regular send.
"session" | "local"
Where an anonymous session id lives: this tab (session, the default) or every tab (local).
RegExp[]
Replaces the default redaction patterns for URLs and payloads.