SessionSight: Install and verify
Overview
Use this page to install the SessionSight tracking snippet and verify it is sending data. SessionSight is LoadGen's session and behavior analytics module: a script tag added to a site records pageviews, clicks, scroll depth, replays, and heatmap data for the selected container, a tracked site that belongs to a tenant. A dropped snippet fails silently, so this page gives you the code to paste, a checklist that confirms each stage of the pipeline, and a live feed of arriving events.
Before you reach this page, the tenant and container you want to track must already exist, with an API key, set up on the Tenants, Containers, and Keys tabs of this configuration area. Once events are confirmed here, Visitors, Heatmaps, Replay, Funnels, and Journeys depend on this container's traffic, and Goals and Channel Grouping rules only start matching once pageviews flow.
On this page you copy the snippet to paste into your site, read a checklist that turns green as each capability proves itself, watch a live feed of recent events, and send a test event or refresh on demand.
Key concepts
- Container - A trackable property, typically one website or app, that holds its own tracking configuration, allowed origins, retention, and privacy rules. (related: Configuration: SessionSight: SessionSight)
- Tenant - The top-level organization that owns one or more containers; selecting a tenant filters which containers you can pick. (related: Configuration: SessionSight: SessionSight)
- Checks - An automated checklist that validates the tracking pipeline end to end for the selected container: snippet loaded, pageviews arriving, behavior collection, first replay, and first heatmap snapshot.
- Live events - A real-time feed of the most recent pageview, click, and scroll events received from the container, used to confirm data is flowing without opening Visitors or Replay. (related: SessionSight: Visitors)
- Allowed origins - The list of site origins a container accepts tracker data from; leaving it empty accepts posts from any site, which is convenient while testing but should be restricted before going live. (related: Configuration: SessionSight: SessionSight)
When to use it
- Right after creating a new container, to get the exact script tag to paste into the site.
- When a site has gone quiet and you need to see which stage of the pipeline (snippet, origin, pageviews, behavior collection) stopped working.
- Before relying on Goals, Funnels, Heatmaps, or Replay for a container, to confirm the underlying checks have gone green at least once.
- When restricting which sites may send data, to see the current Origin allowed warning and confirm it clears after you add an allowed origin.
Before you begin
- A tenant and a container already exist for the site you want to track, created on the Tenants and Containers tabs of this configuration page (Configuration: SessionSight: SessionSight).
- The container has an API key; generate one from the Keys tab, since Send test event and the checks need a working key to pass.
- A site to add the snippet to, with access to its page head, for example an internal test environment at sut-crane-08.
- If you plan to restrict traffic, decide the site's origin (scheme://host[:port]) in advance; you add it as an allowed origin on the Containers tab.
Common workflows
Install the snippet on a new site
Persona: Operator setting up tracking for a new container
- Select the Copy button next to 1. Paste the snippet.
- Expect: The full script tag is copied to the clipboard.
- Paste the copied script tag into the head of every page of the site.
- Expect: Once a visitor loads the site, the snippet starts posting events to the container.
- Select the Refresh button.
- Expect: The checklist, KPI cards, and Live events feed reload; Snippet loaded, Pageviews arriving, Behavior collection on, First replay, and First heatmap snapshot move to a green check once the site has generated enough traffic.
Verify: All five pass/fail checks show a green check mark and the Live events feed lists recent pageview, click, or scroll rows with timestamps of minutes or seconds, not hours.
Confirm a container's key works before going live
Persona: Operator validating a new API key
- Select the Send test event button.
- Expect: SessionSight generates a synthetic event for the selected container.
- Select the Refresh button.
- Expect: The Events, last 30 min KPI increases and the new test event appears at the top of the Live events feed with a timestamp of seconds or minutes ago.
Verify: A new row for the test event appears at the top of 3. Live events with a very recent timestamp, confirming the container and its API key accept and display events end to end.
Steps
Step 1
Open the Install tab for the selected Tenant and Container.
Expected result: The page shows the script snippet to paste under 1. Paste the snippet, a seven-item checklist under 2. Checks, three KPI cards (Visitors and Events in the last 30 minutes, and events in the last 24 hours), and a live feed of recent events under 3. Live events.
This is the starting point for confirming that tracking is installed and working for this container.
- The code block under 1. Paste the snippet is read-only; use Copy to copy it, not to edit it.
-
Tenant and Container at the top scope every check and the live feed to one site.
Step 2
Select the Refresh button in the header.
Expected result: The KPI cards, checklist, and live events feed reload; the feed's Visitor and Channel columns now read Visitor detail and Source for the same rows, and the two informational checks still show their Origin allowed and LoadGen agents marked synthetic hints.
- Send test event stays available if the feed still looks empty after a refresh.
-
Pause stops the live feed from auto-updating while you read a specific row.
Tabs on this page
-
Tenants - Manages the top-level tenant records (Tenant ID, Company Name) that group containers under an organization.
- Tenant ID, Company Name; add, edit, or delete a tenant before creating containers under it.
-
Containers - Manages the trackable sites or apps under the selected tenant, including the datasource, retention, allowed origins, and privacy masking that the checks on this page depend on.
- Container ID, Name, Description, Main URL, Datasource Name, Timezone, Status, Max Sessions/Day, Retention (days), Allowed origins, Privacy masking, URL normalization rules.
-
Keys - Shows and manages the API key bound to the selected container, the credential the tracking snippet authenticates with.
- Generate Key, Cycle Key, Revoke Key for the container's single API key.
-
Install - This page: paste the tracking snippet, review the automated integration checks, and watch the live events feed to confirm data is flowing.
- Tenant, Container, snippet code block, Checks list, KPI cards, Live events feed.
-
Behavior settings - Configures what on-page behavior (clicks, scroll depth, replay, heatmap capture) the snippet records once installed.
- Behavior collection toggles consumed by the Behavior collection on, First replay, and First heatmap snapshot checks.
-
Privacy - Configures masking and data-handling rules that govern what the snippet is allowed to capture or store.
- Privacy masking mode and related data-handling rules for the selected container.
-
Goals - Defines completion goals (a target URL or event plus conditions) used to measure conversion once events are arriving.
- Name, Type, Target URL, URL Match Type, Event Name, Scroll Depth %, Conditions, Completion Value.
-
Funnels - Defines multi-step funnels to analyze drop-off across a sequence of goals once traffic is confirmed flowing.
- Name, Max Step Delay (min), ordered Steps.
-
Channel Grouping - Defines ordered rules that classify incoming traffic into channels, plus a default fallback channel.
- Default channel, ordered rules (move up/down), consumed by the live feed's Channel column.
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Tenant | Selects which organization's containers, checks, and live feed this page scopes to; switch it to inspect a different tenant's tracking setup. | dropdown, populated from tenants created on the Tenants tab | No | first tenant available to your account |
| Container | Selects which tracked site or app the snippet, checklist, and live feed below belong to; changing it swaps to a completely different site's data. | dropdown, filtered to containers under the selected Tenant | No | first container under the selected tenant |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Visitors, last 30 min | Count of unique visitors seen in the trailing 30 minutes; use it to see whether anyone is on the site right now. | 0 is expected outside live traffic or test events; a non-zero value confirms the container is currently receiving visits. |
| Events, last 30 min | Count of all events (pageview, click, scroll, and so on) in the trailing 30 minutes, a finer-grained freshness signal than the 24-hour total. | Stays at 0 if no events landed in the last half hour, even if the 24-hour total is high. |
| Events received in the last 24 hours | Rolling total of events over the last day, with the relative time of the latest one underneath; the headline number to check that the container is still active. | A high count with an old Latest event time means the container was active but has gone quiet recently; check the checklist for what changed. |
| Snippet loaded | Confirms the script tag on the site has executed and reported in at least once. | A green check means the snippet is present and running; if it never turns green, the script tag is missing, blocked, or pointed at the wrong host. |
| Origin allowed | Shows whether the container restricts which site origins may post tracker data. | The grey info icon here is not an error: it means any origin can currently post events. Add the site's origin on the Containers tab to lock this down before going live. |
| Pageviews arriving | Confirms at least one pageview event has been received from the site. | Green means the snippet is firing on page loads; if Snippet loaded is green but this stays unchecked, the snippet loaded but is not sending pageview events. |
| Behavior collection on | Confirms click and scroll behavior tracking is enabled and reporting for this container. | Green means clicks or scroll events have been captured; what gets collected is configured on the Behavior settings tab. |
| First replay | Confirms at least one session replay recording has been captured for this container. | Green means replay data exists to view on Replay; if it stays unchecked while other checks pass, replay may be disabled in Behavior settings. |
| First heatmap snapshot | Confirms at least one heatmap snapshot has been generated for this container. | Green means a heatmap is available on Heatmaps; if it lags behind the other checks, give the site more traffic or wait for the next snapshot cycle. |
| LoadGen agents marked synthetic | Shows whether LoadGen's own synthetic load-testing traffic has been seen and tagged as synthetic for this container in the last 30 days. | The info state just means no synthetic session has run recently; it does not affect real visitor data and clears once a LoadGen load test hits the tracked site. |
| Event | Describes the action that generated the event, typically the page path that was viewed, clicked on, or scrolled. | Read it as Viewed, Clicked on, or Scrolled X% of, followed by the page path, to tell which page and action produced the row. |
| Event type | Badges the row as pageview, click, or scroll so you can scan the feed for a specific kind of interaction. | pageview rows confirm the Pageviews arriving check; click and scroll rows confirm Behavior collection on. |
| Visitor | Identifies who generated the event: anonymous or known, plus device and browser. | Anonymous visitor means no identity has been matched yet; device and browser help you recognize test traffic versus real visitors. |
| Channel | Shows the traffic channel the visit was attributed to by the container's channel grouping rules. | Direct means no referrer or campaign parameter matched a rule; configure rules on the Channel Grouping tab to classify traffic more precisely. |
| Time | Shows when the event was received, relative to now. | Recent values (seconds or minutes ago) confirm the feed is live; a feed stuck on hours-old timestamps means new events have stopped arriving. |
Controls reference
Refresh
Re-fetches the KPI cards, checklist, and live events feed for the selected Tenant and Container.
Side effects: Read-only: it re-reads current data, it does not send or alter any tracking data.
Copy
Copies the full script snippet shown under 1. Paste the snippet to the clipboard.
When to use: When you are ready to paste the tracking code into the head of every page of the site.
Side effects: Read-only: copies text only, no server-side change.
Pause
Stops the Live events feed from automatically adding new rows.
When to use: When you want to read or compare specific rows without the list shifting as new events arrive.
Side effects: Local to your view only: it does not stop event collection on the server, only the feed's auto-updating display.
Send test event
Generates a synthetic event for the selected container and sends it through the same pipeline as real tracker traffic.
When to use: Right after setting up a container and key, to confirm the pipeline works before real visitors arrive, or to rule out the API key as the cause when a site is not reporting.
Side effects: Mutating: it creates a real event record for this container, visible in the live feed and counted in the KPI cards.
Verify the result
Installation is confirmed once the checklist under 2. Checks shows a green check mark next to Snippet loaded, Pageviews arriving, Behavior collection on, First replay, and First heatmap snapshot, and the Events received in the last 24 hours KPI is counting up rather than stuck at 0. The Live events feed should list recent pageview, click, and scroll rows with timestamps of minutes or seconds ago rather than hours. Origin allowed and LoadGen agents marked synthetic can stay on their informational (grey) state without indicating a problem. If the checklist stays unchecked and the feed stays empty after a Refresh, the snippet most likely never reached the live site or is blocked before it can post.
Troubleshooting
- Symptom: The checklist never turns green and 3. Live events stays empty after Refresh. Fix: Confirm the script tag from 1. Paste the snippet is actually present in the page head on the live site, not just in a draft or cached version.
- Symptom: Snippet loaded is green but Pageviews arriving never checks. Fix: Open the site in a browser and check for script errors or an ad blocker preventing the tracker from posting; a working snippet with no pageviews usually means the request is blocked after it loads.
- Symptom: Origin allowed keeps showing its info hint even after you expect it to clear. Fix: Add the site's exact origin (scheme://host[:port], for example https://shop.example.com) to the container's allowed origins on the Containers tab; a mismatched scheme or port will not match.
- Symptom: Send test event does not produce a row in the Live events feed. Fix: Select Refresh afterward; the feed does not update on its own the instant the test event is sent.
- Symptom: Events received in the last 24 hours is high but Latest event shows many hours ago. Fix: Treat this as a recent stoppage, not a historical success: recheck the snippet and origin settings, since the pipeline worked earlier but has since stopped.
Related articles
- Prerequisite: Configuration: SessionSight: SessionSight - Tenants, Containers, and Keys are created and managed there before this page has anything to install or verify.
- See also: SessionSight: Behavior settings - Controls what the snippet captures (clicks, scroll, replay, heatmaps) once the checks here confirm it is installed.
- See also: SessionSight: Privacy - Governs masking and data-handling rules that apply to the same events shown in the live feed.
- Next step: SessionSight: Visitors - Once events are confirmed arriving here, Visitors shows the full visitor history for the container.
- Next step: SessionSight: Dashboard - Aggregates the traffic this page confirms is flowing into charts and trends.
- Next step: SessionSight: Heatmaps - Uses the heatmap snapshots whose first capture this page's checklist confirms.