Configuration: SessionSight: SessionSight
Overview
Use this page to create and configure the SessionSight tenants and containers that collect session analytics data. A tenant is one customer or company you track; a container is one website or application property within that tenant, each with its own tracker key, ingestion limits, and privacy settings. Every other SessionSight feature depends on a tenant and container existing here first.
A container needs an existing datasource, created on Configuration: Datasources, before it can be saved. Once a container has an API key, its tracker snippet can be embedded on the tracked site to start sending session events, which then populate SessionSight: Dashboard, SessionSight: Visitors, and the goals, funnels, and channel reports configured here.
Tabs on this page scope every setting to the Tenant and Container selected at the top: Tenants and Containers define the hierarchy and ingestion rules, Keys manages the tracker's API key, Goals and Funnels define conversion targets, Channel Grouping classifies traffic sources, Tenant Groups combine tenants for reporting, and Connectors links external systems such as Google Analytics 4.
Key concepts
- Tenant - An organizational entity in SessionSight, typically one customer or company, that scopes every container, key, goal, and other setting beneath it. Tenants are identified by a Tenant ID and a Company Name. (related: SessionSight: Dashboard)
- Container - A tracked website or application property within a tenant, bound to one datasource and carrying its own API key, ingestion limits, retention, and privacy masking settings. (related: Configuration: Datasources)
- Goal - A conversion target, defined by a Target URL, Event Name, or Scroll Depth %, that SessionSight checks recorded sessions against to measure completion. (related: SessionSight: GA4)
- Funnel - An ordered sequence of Steps that a session must pass through; used to measure how many visitors complete each step and where they drop off. (related: SessionSight: Funnels)
- Connector - An integration that either pulls data in from an external source (an inbound connector, such as Google Analytics 4) or pushes SessionSight data out to one (an outbound sink). (related: SessionSight: GA4)
When to use it
- Setting up a new customer or property before any tracking can start, by adding a tenant and a container.
- Issuing, rotating, or revoking the API key a tracker snippet uses to send session data.
- Defining the conversion goals or funnels used to measure visitor completion rates for a container.
- Adjusting how traffic sources are classified into reporting channels, or setting the fallback channel.
- Grouping several tenants together so their data can be reported on as one unit.
- Connecting or disconnecting an external system, such as pulling data in from Google Analytics 4.
Before you begin
- SessionSight must be licensed for your account; an unlicensed visit loads no tenants, containers, or datasources on this page.
- A datasource must already exist on Configuration: Datasources before you can save a new container, since every container stores its session data in one.
- Know the exact origins (in scheme://host[:port] format) that the tracked site will send tracker data from, for the container's Allowed origins field.
- You need administrator-level access to this configuration area; the examples in this article were captured with a GlobalAdmin account.
Common workflows
Add a tenant and container to start collecting session data
Persona: SessionSight administrator
- On the Tenants tab, select Add Tenant.
- Expect: A modal opens with Tenant ID and Company Name fields.
- Enter a Tenant ID and Company Name, then save.
- Expect: The new tenant appears as a row in the Tenants table.
- Select the new tenant in the Tenant dropdown, switch to the Containers tab, and select Add Container.
- Expect: A modal opens for Container ID, Main URL, Datasource Name, and Allowed origins.
- Fill in the required fields and save.
- Expect: The container appears in the Containers list, bound to the chosen tenant and datasource.
Verify: The Tenants table lists the new tenant, and selecting it in the Tenant dropdown while on the Containers tab shows the new container row with the Main URL and Datasource you assigned.
Issue a tracker key and get the embed snippet
Persona: SessionSight administrator or developer
- With the tenant and container selected, switch to the Keys tab and select Generate Key.
- Expect: A new API key is created for the container, since it did not have one yet.
- Select Get Tracker Code.
- Expect: The JavaScript tracker snippet containing the key is returned for you to embed on the tracked site.
Verify: The Keys tab shows an active key for the container, and the tracker snippet can be retrieved again at any time with Get Tracker Code as long as the key is not revoked.
Define a conversion goal for a container
Persona: Performance analyst
- On the Goals tab, select Add Goal.
- Expect: A modal opens with Name, Target URL, URL Match Type, Event Name, Scroll Depth %, Conditions, and Completion Value fields.
- Enter a Name and at least one completion rule (Target URL, Event Name, or Scroll Depth %), then save.
- Expect: The goal appears as a new row in the Goals list.
Verify: The goal is listed on the Goals tab, and selecting Goal Analytics on that row opens its completion data once matching sessions have been recorded.
Steps
Step 1
Open SessionSight configuration, which lands on the Tenants tab.
Expected result: The page loads with the Tenant filter set to LoadGen B.V., the Container filter set to Production Web App, and a single tenant row, loadgen-main / LoadGen B.V., whose Analytics column shows a Disabled status pill.
This is the scoping starting point for every other tab on the page, including Containers, Keys, Goals, Funnels, and Connectors.
- The Tenant and Container dropdowns at the top scope every tab below to one tenant/container pair.
- Refresh reloads the current tab's data without changing your filter selections.
-
Add Tenant opens the form to create a new tenant before you can configure containers, keys, goals, or funnels for it.
Tabs on this page
-
Tenants - Lists every tenant configured in SessionSight and lets you add, edit, or delete one.
- Tenant ID, Company Name, and a read-only Analytics status per row.
-
Containers - Lists the tracked site or application properties that belong to the selected tenant, each bound to a datasource, with ingestion limits, retention, privacy masking, URL normalization, and scheduler timers.
- Container ID, Name, Main URL, Datasource Name, Timezone, Status, Max Sessions/Day, Retention (days), Allowed origins, Privacy masking, and the Scheduler Configuration timers.
-
Keys - Manages the single API key that authenticates the selected container's tracker snippet, and returns the embeddable tracker code.
- Generate Key, Cycle Key, Revoke Key, and Get Tracker Code; one active key per container.
-
Goals - Defines conversion targets, such as a URL reached, an event fired, or a scroll depth passed, evaluated against sessions for the selected container.
- Name, Target URL, URL Match Type, Event Name, Scroll Depth %, Conditions, Completion Value.
-
Funnels - Defines ordered step sequences that sessions are matched against to measure step-by-step conversion and drop-off.
- Name, Steps, Max Step Delay (min).
-
Channel Grouping - Defines the ordered rules that classify incoming traffic into reporting channels, plus the fallback channel used when no rule matches.
- Rule order (move up/down), Default channel.
-
Tenant Groups - Groups several tenants into one named unit for consolidated reporting.
- Name, Member tenants checklist.
-
Connectors - Connects external systems: inbound connectors pull data in (for example, from Google Analytics 4), and outbound sinks push SessionSight data out, both scoped to the selected tenant or container.
- Source, Display name, Customer ID / Property ID, Pull schedule (cron).
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Tenant | Scopes every tab below to one tenant. Switch it to review or edit a different tenant's containers, keys, goals, funnels, and other settings. | dropdown | No | - |
| Container | Scopes the container-level tabs (Keys, Goals, Funnels, Channel Grouping, scheduler settings) to one container of the selected tenant. | dropdown | No | - |
| Tenant ID | Sets the unique identifier for a new tenant. Choose a short, stable value since other configuration (containers, keys) is organized underneath it. | text | Yes | - |
| Company Name | Sets the human-readable name shown for the tenant in the Tenants list. | text | No | - |
| Container ID | Sets the unique identifier for a new container within the selected tenant. | text | Yes | - |
| Name | Sets a display name for the container in the Containers list. | text | No | - |
| Description | Adds free-text notes about what the container tracks, for your own reference. | text | No | - |
| Main URL | Sets the canonical site address this container tracks. It is the reference used when deciding whether to restrict the Allowed origins list to just this site. | URL | No | - |
| Datasource Name * | Selects the datasource this container's session data is stored in. A container cannot exist without one; pick an existing datasource or create one inline with the plus button. | dropdown | Yes | - |
| Timezone | Sets the timezone used to bucket the container's session data by day and hour. Choose the timezone where your traffic or your reporting team is based so daily and hourly rollups line up with expectations. | dropdown | No | - |
| Status | Controls whether the container is currently active and accepting tracker data. Pause it to stop collecting new sessions temporarily without deleting the container's configuration. | toggle or dropdown | No | - |
| Max Sessions/Day | Caps how many sessions this container records per day. Set it lower to limit ingestion volume on high-traffic sites; set it higher to avoid dropping sessions during traffic spikes. | number | No | - |
| Retention (days) | Sets how many days of session data are kept before the purge job removes it. A higher value keeps more history available for replay and funnel analysis at the cost of storage; a lower value reduces storage but shortens how far back you can investigate. | number | No | - |
| Allowed origins * | Lists the origins, in scheme://host[:port] format, permitted to send tracker events to this container. Leave it empty to accept data from any website while testing; add the container's known hosts and save to restrict ingestion once you are ready to lock it down. | list of origins | No | - |
| Privacy masking | Selects how much of a visitor's recorded input and page content is obscured before storage. Choose a stricter level to protect sensitive data such as form input, at the cost of less raw detail in replay and analysis; choose a looser level when privacy risk is lower. | option group | No | - |
| Built-in rules (numeric / GUID / date / hash) | Turns on automatic normalization of dynamic URL segments (identifiers, GUIDs, dates, hashes) into a single placeholder for reporting. Turn it on to group parameterized URLs like /user/123 and /user/456 into one reported path; turn it off to keep every unique URL distinct. | toggle | No | - |
| Type | Selects what kind of URL segment a custom normalization rule matches, so it can be collapsed to a consistent placeholder in reporting. | dropdown | No | - |
| Expression (legacy) | Defines the custom match pattern for a normalization rule using the older expression syntax, for rules that predate the built-in rule types above. | text | No | - |
| Value | Sets the placeholder text that a matched URL segment is replaced with, so varying real values collapse into one consistent reported path. | text | No | - |
| Analytics Rollup Interval (min) | Sets how often, in minutes, raw session events are aggregated into analytics rollups. Lower values make dashboards reflect new sessions sooner at the cost of more frequent processing; higher values reduce processing load but delay when new data appears in reports. | number | No | - |
| Session Tracker Sync Interval (min) | Sets how often, in minutes, the tracker's configuration (key and rules) syncs to the deployed snippet. Lower values make changes like a rotated key take effect on the live site sooner; higher values reduce sync overhead. | number | No | - |
| IP Cache Maintenance Time (HH:mm) | Sets the time of day the IP lookup cache used for session geolocation and deduplication is refreshed. Schedule it for a low-traffic window to avoid lookup slowdowns during maintenance. | time (HH:mm) | No | - |
| Retention Purge Time (HH:mm) | Sets the time of day the purge job removes session data older than the Retention (days) value. Schedule it for a low-traffic window since the purge runs against the full dataset. | time (HH:mm) | No | - |
| Name * | Identifies the Goal, Funnel, or Tenant Group you are creating, depending on which tab's Add dialog is open. Shown afterward in that tab's list. | text | Yes | - |
| Target URL | Sets the page a visitor must reach for this goal to count as completed. Used together with URL Match Type to decide how strictly the visited URL must match. | URL | No | - |
| URL Match Type | Controls how closely a visited page's URL must match the Target URL for the goal to count as completed. Choose a stricter setting to avoid counting unrelated pages; choose a looser setting to also match variations such as added query parameters or sub-paths. | dropdown | No | - |
| Event Name | Names a custom tracked event that completes this goal when it fires during a session, as an alternative to a URL-based goal. | text | No | - |
| Scroll Depth % | Sets the percentage of a page's height a visitor must scroll past for the goal to complete. A higher percentage requires deeper engagement before the goal fires. | number (percent) | No | - |
| Conditions | Adds extra match conditions, via Add Condition, that must also be true for a session to count toward this goal, narrowing it beyond a single URL, event, or scroll rule. | list builder | No | - |
| Completion Value | Assigns a numeric value to each completion of this goal, used when comparing the value delivered by different goals, funnels, or channels. | number | No | - |
| Steps | Defines the ordered sequence of pages or events, added via Add Step, that a session must pass through for this funnel. The list order is the order visitors are expected to complete them in. | list builder | No | - |
| Max Step Delay (min) | Sets the longest gap, in minutes, allowed between two consecutive funnel steps before a session stops counting as progressing through the funnel. A lower value enforces stricter timing; a higher value tolerates slower visitor behavior while still counting the funnel as completed. | number | No | - |
| Default channel (used when no rule matches) | Sets the channel a session is reported under when none of the channel grouping rules above match its traffic source. Choose a catch-all value so totals stay meaningful even for unmatched sessions. | dropdown | No | - |
| Member tenants | Checks which tenants belong to this tenant group, so that reporting scoped to the group rolls up data from all its member tenants. | checkbox list | No | - |
| Source | Selects the external system this connector pulls from or pushes to. Determines which other fields, such as Customer ID or Property ID, are shown. | dropdown | No | - |
| Display name * | Names this connector instance in the Connectors list. | text | Yes | - |
| Customer ID / Property ID | Identifies the specific account or property in the external system to pull from or push to. The label shown depends on the selected Source; a Google Analytics 4 connector asks for a Property ID. | text | No | - |
| Pull schedule (cron, optional) | Sets how often this connector automatically pulls data from the external source, as a cron expression. Leave it blank to only pull data when triggered manually; set a schedule to keep imported data refreshed automatically at that cadence. | cron expression | No | - |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Tenant ID | - | Identifies which tenant the row represents; it is also a link into that tenant's scope. |
| Company Name | - | Shows the human-readable name for the Tenant ID in the same row. |
| Analytics | - | A read-only signal of whether session analytics are active for this tenant's containers. Disabled is the only value confirmed here; it reflects the configuration on the Containers tab rather than being a toggle on this row. |
| Actions | - | Contains the edit (pencil) and delete (trash) icons for that row instead of a separate actions menu. |
Controls reference
Refresh
Reloads the active tab's data for the currently selected Tenant and Container.
When to use: Use it after a change made elsewhere (for example, by another admin) to confirm you are looking at current data.
Side effects: Read-only; does not change any configuration or your current filter selections.
Add Tenant
Opens a modal to create a new tenant with a Tenant ID and Company Name.
When to use: Use it before configuring any containers, keys, goals, or funnels for a new customer or company.
Side effects: Mutating: saving adds a new row to the Tenants table.
Edit (row action)
Opens an edit modal prefilled with that row's data. Appears on Tenants, Containers, Goals, Funnels, Tenant Groups, and Connector rows.
When to use: Use it to change a value on an existing tenant, container, goal, funnel, tenant group, or connector without recreating it.
Side effects: Mutating once saved; the row's displayed values update to match your changes.
Delete (row action)
Opens a delete confirmation modal for that row. Appears on Tenants, Containers, Goals, Funnels, Tenant Groups, and Connector rows.
When to use: Use it to permanently remove a tenant, container, goal, funnel, tenant group, or connector you no longer need.
Side effects: Mutating and destructive once confirmed; deleting a tenant or container also removes the configuration scoped beneath it (its containers, keys, goals, funnels).
Cancel
Closes the currently open add or edit modal.
When to use: Use it to back out of a form without saving any entered values.
Side effects: Read-only; discards unsaved input in the modal.
Save (forms)
Persists whichever add/edit modal or the Scheduler Configuration panel is currently open.
When to use: Use it once required fields are filled in correctly to commit the tenant, container, goal, funnel, tenant group, connector, or scheduler change.
Side effects: Mutating: writes the change and closes the modal, or shows a validation error if a required field or format check fails.
Add Container
Opens a modal to define a new container under the selected tenant.
When to use: Use it to start tracking a new site or application property for the selected tenant.
Side effects: Mutating: saving adds a new row to the Containers list.
Privacy masking mode buttons
Switches the active masking mode applied to this container's recorded data; the selected option is shown in a filled, highlighted style.
When to use: Use it to balance replay detail against protecting sensitive visitor input.
Side effects: Takes effect once the container form is saved; applies going forward to newly recorded sessions.
Add rule (URL normalization)
Appends a new custom normalization rule row (Type, Expression, Value) to the container's path discovery list.
When to use: Use it when the Built-in rules toggle does not already collapse a repeating URL pattern you want grouped in reporting.
Side effects: Local to the form until saved; saving the container persists the new rule.
Remove rule (URL normalization)
Deletes a custom normalization rule row from the container's path discovery list.
When to use: Use it to retire a normalization rule that no longer applies.
Side effects: Local to the form until saved; saving the container persists the removal.
Generate Key
Creates a new API key for the selected container.
When to use: Use it for a container that does not yet have a key, before embedding a tracker snippet.
Side effects: Mutating: fails if the container already has a key, since only one key exists per container at a time.
Cycle Key
Replaces the container's existing API key with a new one, invalidating the old one.
When to use: Use it to rotate a key that may be compromised or as routine key hygiene, without changing the container's other settings.
Side effects: Mutating and disruptive to any tracker snippet still using the old key; fails if the container has no key to cycle.
Revoke Key
Disables the container's current API key.
When to use: Use it to immediately stop a tracker snippet from sending data, for example when retiring a site.
Side effects: Mutating and destructive to data collection: trackers using the revoked key are no longer accepted once it is revoked.
Get Tracker Code
Retrieves the JavaScript tracker snippet tied to the container's current key.
When to use: Use it once a key has been generated, to obtain the code to embed on the tracked site.
Side effects: Read-only; requires a valid key on the container or it returns no snippet.
Manage (key row)
Opens management actions for a specific row in the key inventory list.
When to use: Use it to act on a particular key entry when more than the current container's key is listed.
Side effects: Read-only navigation; disabled when there is no key to manage for that row.
Identity (Phase 1)
Opens an early-phase Identity capability on the Keys tab, flagged New.
When to use: Use it if you want to try the newly introduced Identity feature for this container's key.
Side effects: Not fully confirmed from this page; treat it as a preview feature and review what it changes before relying on it.
Add Goal
Opens a modal to define a new goal (Name, Target URL, URL Match Type, Event Name, Scroll Depth %, Conditions, Completion Value) for the selected container.
When to use: Use it to start measuring a specific conversion, such as reaching a page or firing an event.
Side effects: Mutating: saving adds a new row to the Goals list.
Goal Analytics
Opens the completion performance view for that goal.
When to use: Use it to check how often and how recently a goal has been completed.
Side effects: Read-only.
+ Add Condition
Adds an extra condition row to the goal being defined.
When to use: Use it to narrow a goal beyond a single URL, event, or scroll-depth rule.
Side effects: Local to the form until the goal is saved.
Add Funnel
Opens a modal to define a new funnel (Name, Steps, Max Step Delay) for the selected container.
When to use: Use it to analyze how visitors progress through, and drop off from, a multi-step sequence.
Side effects: Mutating: saving adds a new row to the Funnels list.
Funnel Analytics
Opens the step-by-step conversion and drop-off view for that funnel.
When to use: Use it to see where visitors are leaving the funnel.
Side effects: Read-only.
+ Add Step
Appends a new step row to the funnel being defined.
When to use: Use it to add the next page or event visitors must pass through, in order.
Side effects: Local to the form until the funnel is saved.
Remove item (list row icon)
Removes a condition row from a goal, a step row from a funnel, or a condition row from a segment.
When to use: Use it to drop a condition or step you no longer want as part of that goal, funnel, or segment.
Side effects: Local to the form until the parent item is saved.
Move rule up / Move rule down
Changes a channel grouping rule's position in the evaluation order.
When to use: Use it when two rules could both match the same traffic and you need the more specific one evaluated first.
Side effects: Mutating: the new order is what gets evaluated against future sessions once saved.
Remove rule (channel grouping)
Deletes a channel grouping rule.
When to use: Use it to retire a traffic classification rule that no longer applies.
Side effects: Mutating; sessions that rule used to match now fall through to the next rule or the Default channel.
Add Segment
Opens a modal to define a new visitor segment, with its own conditions, scoped to the container's datasource.
When to use: Use it to build a reusable filter for a group of sessions you analyze repeatedly.
Side effects: Mutating: saving adds a new row to the segment list; fails if the container has no datasource available.
Dismiss
Closes an informational banner on the page.
When to use: Use it once you have read the banner's message and no longer need it visible.
Side effects: Read-only; does not change any configuration.
Go to Tenants / Go to Containers
Jumps to the Tenants or Containers tab.
When to use: Use it when a tab such as Keys, Goals, or Funnels has no tenant or container selected yet and prompts you to set one up first.
Side effects: Read-only navigation within the page.
Verify the result
After creating a tenant, its row appears in the Tenants table with the Company Name you entered. Selecting that tenant in the Tenant dropdown and switching to the Containers tab shows the new container with the Main URL and Datasource you assigned to it. If a save did not go through, the table still shows only the prior rows and the form reports which required field is missing. Check first that Tenant ID (or Container ID) and any field marked with an asterisk, such as Datasource Name or Allowed origins, were filled in, since those are the checks this page enforces before saving.
Troubleshooting
- Symptom: Saving a new tenant fails or does nothing. Fix: Confirm the Tenant ID field is filled in; it is required and the row will not save without it.
- Symptom: Saving a container fails with a datasource error. Fix: Pick an existing datasource in Datasource Name, or create one inline with its plus button; a container cannot be saved without one.
- Symptom: The container save is rejected because of Allowed origins. Fix: Enter at least one origin in scheme://host[:port] format; an empty list is fine while the container is unrestricted, but any entries you add must match that format.
- Symptom: Generate Key fails for a container. Fix: The container already has a key; use Cycle Key instead of trying to create a second one.
- Symptom: Cycle Key reports there is no key to cycle. Fix: The key was revoked or never created; use Generate Key instead.
- Symptom: Get Tracker Code returns no snippet. Fix: Generate or cycle a key for the container first; a snippet can only be produced for a container with a valid key.
Related articles
- Prerequisite: Configuration: Datasources - a container cannot be saved without a datasource created there
- Next step: SessionSight: Dashboard - view the session analytics collected from the tenants and containers configured here
- Next step: SessionSight: Visitors - browse individual visitor sessions recorded for the containers configured here
- Next step: SessionSight: Funnels - see the step-by-step results for funnels defined on this page
- See also: SessionSight: GA4 - view data pulled in through a Google Analytics 4 connector set up on the Connectors tab