Pirsch Documentation

Appearance

Extending Sessions ​

Pirsch has the capability to keep sessions alive. We do not recommend using this feature for regular websites, but it can be useful for mobile applications, single page applications and other types of software where you have long running sessions. Otherwise, a session will only be kept alive if you send a pageview, which is usually the desired behaviour.

Extending a session prevents unnecessary page views from being generated.

INFO

A single session extension is counted as 10% of a page view and therefore counts towards your page view limit. Updating a session 10 times will be counted as one page view.

Extending Sessions Using Javascript ​

To extend sessions from the browser, add the script snippet to your website and adjust the configuration by adding the data-enable-sessions attribute.

html
<script defer src="https://api.pirsch.io/pa.js"
    id="pianjs"
    data-code="YOUR_IDENTIFICATION_CODE"
    data-enable-sessions></script>

This will automatically send a ping to Pirsch every 60 seconds. If you want to change the interval, add the data-interval-ms attribute. You can then specify the interval in milliseconds.

html
<script defer src="https://api.pirsch.io/pa.js"
    id="pianjs"
    data-code="YOUR_IDENTIFICATION_CODE"
    data-enable-sessions
    data-interval-ms="30000"></script>

Extending Sessions Using the API ​

Sessions can be extended by sending a simple request to the API.

Bash
POST https://api.pirsch.io/api/v1/session

{
    "ip":                           "123.456.789.0",
    "user_agent":                   "User-Agent header",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)"
}

The data must be identical to the data used to send a regular page view.