Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cevoid.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this page when you already know you need the Cevoid Analytics SDK and want the supported installation paths. If you are still deciding between automatic gallery behavior, browser-event subscriptions, or manual tracking, start with Overview.

​
Choose one path

Use the installation path that matches how your storefront is built:
  • Script tag: fastest setup when you want browser-only initialization and no package imports
  • npm package: best default when you control storefront application code directly
  • React: use when your storefront already renders through React

​
Script tag

Use the script tag when you want the fastest setup and do not need package imports. 
<script
  type="module"
  src="https://cdn.cevoid.com/analytics/v1/script.js"
  data-publishable-key="cev_pk_..."
  data-enable-session-tracking="true"
  data-cookie-domain=".example.com"
></script>
The script reads these data-* attributes:
  • data-publishable-key
  • data-enable-session-tracking
  • data-cookie-domain
  • data-api-host
  • data-emit-browser-events
After loading, the script auto-initializes and exposes:
  • window.cevoid.init
  • window.cevoid.reset
  • window.cevoid.identify
  • window.cevoid.trackEvent
  • window.cevoid.trackSale
Verification:
  • open the page after the script loads
  • confirm window.cevoid exists
  • send one test call such as window.cevoid.trackSale(...) or listen for a gallery browser event

​
npm package

Use the package entry point when you want full control over initialization from your storefront code. 
npm install @cevoid/analytics-sdk

import { init, trackEvent } from '@cevoid/analytics-sdk'

init({
  publishableKey: 'cev_pk_...',
  enableSessionTracking: true,
  cookieDomain: '.example.com'
})

trackEvent('widget.load', {
  widgetId: 'gallery-homepage',
  widgetType: 'gallery',
  postsLoadedCount: 12
})
Verification:
  • confirm your app starts without SDK import errors
  • trigger one supported tracking call
  • if emitBrowserEvents is left on, confirm the matching browser event appears on window

​
React

Use the React entry point when your storefront already renders through React. 
npm install @cevoid/analytics-sdk

import { Analytics as CevoidAnalytics, trackEvent } from '@cevoid/analytics-sdk/react'

export function App() {
  return (
    <>
      <CevoidAnalytics publishableKey="cev_pk_..." enableSessionTracking={true} />
      <button
        onClick={() =>
          trackEvent('gallery.upload_cta_click', {
            widgetId: 'gallery-homepage',
            widgetType: 'gallery'
          })
        }
      >
        Upload
      </button>
    </>
  )
}
Verification:
  • mount the Analytics component once near your app root
  • trigger one supported tracking call from React code
  • confirm the event path works before layering in session tracking or consent handling

​
Configuration

Call init() once before sending events. The React component uses the same props.
OptionTypeDefaultDescription
publishableKeystring—Required workspace publishable key.
enableSessionTrackingbooleanfalseEnables Cevoid session tracking after consent checks pass.
cookieDomainstring—Sets the domain on the ca_session cookie.
emitBrowserEventsbooleantrueEmits browser CustomEvents such as cevoid:post.click on window.
apiHoststringhttps://telemetry.cevoid.comOverrides the telemetry host for development or controlled environments.
Repeated init() calls after the first successful initialization are ignored.