tracking_recording-settings_get

Tool

tracking_recording-settings_get

Get the session recording setting of the current product: whether recording is on, the percent of sessions recorded, the hosts whose pages are recorded, and candidate hosts to choose from.

Get the session recording setting of the current product: whether recording is on, the percent of sessions recorded, the hosts whose pages are recorded, and candidate hosts to choose from. Off at 0% with no hosts until it is set; on with no hosts records nothing. Returns: { enabled, sampleRate, hosts, candidateHosts }. Fails when: the call carries no product.

Behavior

HTTP: GET /tracking/recording-settings

Arguments

No arguments.

Response

Field	Type	Always	Description
hosts	array	•	Exact hostnames whose pages are recorded, e.g. ["example.com", "www.example.com"]; pages on any other host are never recorded. Bare hosts only — no scheme, port, path or wildcard; www and each subdomain are separate hosts. Up to 20. Recording on with no hosts records nothing.
enabled	boolean	•	Whether session recording is on. Only visitors in full tracking mode (statistics consent, or no consent banner) are recorded.
sampleRate	integer	•	Percent of sessions recorded, 1 to 100 when on (e.g. 25); 0 is allowed only when off.
candidateHosts	array	•	Hosts to choose from when setting hosts: the stored hosts, the product’s install domains, then hosts its tracked pages were on in the last 30 days. A suggestion list, not a filter.

Try it

Get the session recording setting of the current product: whether recording is on, the percent of sessions recorded, the hosts whose pages are recorded, and candidate hosts to choose from.

When to use

Example

Ask your agent something like this:

Get the session recording setting of the current product: whether recording is on, the percent of sessions recorded, the hosts whose pages are recorded, and candidate hosts to choose from.

The agent will invoke tracking_recording-settings_get with these arguments:

{}