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 exact public method surface. If you are still deciding between automatic widget behavior, browser-event forwarding, or manual tracking, start with Overview. Public SDK payload fields use camelCase. The SDK normalizes them to the internal snake_case telemetry format before sending events to the backend.

​
init(config)

Initializes the SDK. Call it once before your first tracking method. Repeated calls after the first successful initialization are ignored.
OptionTypeDefaultDescription
publishableKeystring—Required workspace publishable key.
enableSessionTrackingbooleanfalseEnables Cevoid-managed session tracking after consent checks pass.
cookieDomainstring—Sets the domain for the ca_session cookie.
emitBrowserEventsbooleantrueEmits browser CustomEvents such as cevoid:post.click.
apiHoststringhttps://telemetry.cevoid.comOverrides the telemetry host.
If enableSessionTracking is true, tracked events are deferred until consent resolution completes.

​
trackEvent(name, data)

Tracks a supported Cevoid UGC widget event. 
import { trackEvent } from '@cevoid/analytics-sdk'

trackEvent('post.click', {
  widgetId: 'gallery-homepage',
  widgetType: 'gallery',
  postId: 'post_123',
  postPosition: 4,
  taggedProductIds: ['prod_1', 'prod_2']
})
Use trackEvent() for custom storefront implementations that need to send supported Cevoid event names manually. Supported event names: Unknown event names are ignored.

​
trackSale(data)

Tracks a completed storefront purchase as sale.complete. Use this for manual storefront implementations. Standard Shopify sales tracking uses the checkout web pixel path instead of calling trackSale(). 
import { trackSale } from '@cevoid/analytics-sdk'

trackSale({
  orderId: 'order_123',
  marketId: 'market_123',
  customerId: 'cust_456',
  currency: 'USD',
  revenue: 129.99,
  skus: ['SKU-1', 'SKU-2']
})
Required fields:
  • orderId
  • currency
  • revenue
Optional fields:
  • marketId
  • customerId
  • skus
Use trackSale() for completed purchases, not trackEvent() with sale.complete.

​
identify(data)

Attaches profile-level context to future events. 
import { identify } from '@cevoid/analytics-sdk'

identify({
  profileId: 'profile_123',
  externalId: 'shopify_customer_456'
})
Supported fields:
  • profileId?: string
  • externalId?: string
This data is stored in SDK memory and attached to future tracked events. Call identify() again to replace the current identity payload.

​
reset()

Clears SDK initialization state, deferred events, and in-memory identity data. 
import { reset } from '@cevoid/analytics-sdk'

reset()
Use this on hard storefront context changes such as logout flows when you need to clear the current client-side analytics state.