Choose a version:

getClientBrowserParameters

Gathers client browser values commonly used for analytics

Anchor to getClientBrowserParameters
getClientBrowserParameters()

If executed on server, this method will return empty string for each field.

Anchor to getClientBrowserParameters-returnsReturns

ClientBrowserParameters

navigationApi
Navigation api: `'PerformanceNavigationTiming' | 'performance.navigation'`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
navigationType
Navigation type: `'navigate' | 'reload' | 'back_forward' | 'prerender' | 'unknown'`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
path
Value of `window.location.pathname`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
referrer
Value of `window.document.referrer`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
search
Value of `window.location.search`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
title
Value of `document.title`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
uniqueToken
Shopify unique user token: Value of `_shopify_y` cookie. Use `getClientBrowserParameters()` to collect this value.
```
string
```
url
Value of `window.location.href`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
userAgent
Value of `navigator.userAgent`. Use `getClientBrowserParameters()` to collect this value.
```
string
```
visitToken
Shopify session token: Value of `_shopify_s` cookie. Use `getClientBrowserParameters()` to collect this value.
```
string
```

Examples

import * as React from 'react';

import {useEffect} from 'react';

import {getClientBrowserParameters} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {

useEffect(() => {

getClientBrowserParameters();

});

return <Component {...pageProps} />;

}

Examples

Example code

JavaScript

import * as React from 'react';
import {useEffect} from 'react';
import {getClientBrowserParameters} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getClientBrowserParameters();
  });

  return <Component {...pageProps} />;
}

TypeScript

import * as React from 'react';
import {useEffect} from 'react';
import {getClientBrowserParameters} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getClientBrowserParameters();
  });

  return <Component {...pageProps} />;
}

Anchor to RelatedRelated

sendShopifyAnalytics

useShopifyCookies

Was this page helpful?

Anchor to getClientBrowserParametersgetClientBrowserParameters()

Anchor to getClientBrowserParameters-returnsReturns

ClientBrowserParameters

Anchor to RelatedRelated

Anchor to getClientBrowserParameters
getClientBrowserParameters()