Databuddy

The Databuddy script automatically respects consent preferences by toggling tracking on and off based on the user's consent state.

Script Implementation

Adding the Databuddy script to c15t

Info

See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).

import { databuddy } from '@c15t/scripts/databuddy';

databuddy({
  clientId: 'your-client-id',
  scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
  apiUrl: 'https://basket.databuddy.cc',
  configWhenGranted: {
    clientId: 'your-client-id',
    apiUrl: 'https://basket.databuddy.cc',
    trackScreenViews: true,
    trackOutgoingLinks: true,
    disabled: false,
  },
  configWhenDenied: {
    clientId: 'your-client-id',
    apiUrl: 'https://basket.databuddy.cc',
    disabled: true,
  },
});

Using Databuddy in your application

Once initialized, Databuddy is available globally via window.databuddy or window.db:

// Track a custom event
window.databuddy?.trackCustomEvent('button_clicked', {
  button_id: 'signup',
  page: '/landing',
});

// Or use the shorthand
window.db?.track('purchase_completed', {
  amount: 99.99,
  currency: 'USD',
});

// Track a screen view manually
window.databuddy?.screenView('/dashboard', {
  user_role: 'admin',
});

// Set global properties for all events
window.databuddy?.setGlobalProperties({
  app_version: '1.2.3',
  environment: 'production',
});

The Databuddy integration automatically handles consent management:

Before Script Load: Sets window.databuddyConfig.disabled based on initial consent state
On Consent Grant: Enables tracking by setting window.databuddy.options.disabled = false
On Consent Revoke: Disables tracking by setting window.databuddy.options.disabled = true

This ensures that no tracking occurs without user consent, keeping your analytics privacy-compliant.

Configuration Options

The Databuddy manifest expects explicit initial config objects for the granted and denied consent states:

databuddy({
  clientId: 'your-client-id',
  scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
  apiUrl: 'https://basket.databuddy.cc', // Optional, defaults to basket.databuddy.cc, change if self-hosting
  configWhenGranted: {
    clientId: 'your-client-id',
    apiUrl: 'https://basket.databuddy.cc',
    // Tracking options
    trackScreenViews: true, // Automatically track page views
    trackOutgoingLinks: true, // Track clicks on external links
    trackAttributes: false, // Track data-track attributes on elements
    trackErrors: false, // Track JavaScript errors
    trackPerformance: true, // Track performance metrics
    trackWebVitals: false, // Track Core Web Vitals

    // Network options
    enableBatching: false, // Batch events before sending
    batchSize: 10, // Events per batch
    batchTimeout: 2000, // Batch timeout in ms
    samplingRate: 1.0, // Sample rate (0.0-1.0)
    disabled: false,
  },
  configWhenDenied: {
    clientId: 'your-client-id',
    apiUrl: 'https://basket.databuddy.cc',
    disabled: true,
  },
});

Types

DatabuddyConsentOptions

Property

Types

Loading…

Script

Property

Types

Description

Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed. This is useful for: Example use cases:

Full Type

boolean | undefined

Default

false

Usage

callbackOnly={...}

Loading…

Databuddy

Script Implementation

Adding the Databuddy script to c15t

Using Databuddy in your application

How Consent Management Works

Configuration Options

Types

DatabuddyConsentOptions

plusminusapiUrl?string | undefined

plusminusclientIdrequiredstring

plusminusconfigWhenDeniedrequiredRecord<string, unkno...

plusminusconfigWhenGrantedrequiredRecord<string, unkno...

plusminusscriptUrl?string | undefined

Script

plusminusalwaysLoad?boolean | undefined

plusminusanonymizeId?boolean | undefined

plusminusasync?boolean | undefined

plusminusattributes?any

plusminuscallbackOnly?boolean | undefined

plusminuscategoryrequiredHasCondition<AllCons...

plusminusdefer?boolean | undefined

plusminusfetchPriority?"high" | "low" | "au...

plusminusiabLegIntPurposes?{} | undefined

plusminusiabPurposes?{} | undefined

plusminusiabSpecialFeatures?{} | undefined

plusminusidrequiredstring

plusminusnonce?string | undefined

plusminusonBeforeLoad?((info: ScriptCallba...

plusminusonConsentChange?((info: ScriptCallba...

plusminusonError?((info: ScriptCallba...

plusminusonLoad?((info: ScriptCallba...

plusminuspersistAfterConsentRevoked?boolean | undefined

plusminussrc?string | undefined

plusminustarget?"head" | "body" | un...

plusminustextContent?string | undefined

plusminusvendorId?string | number | un...

plusminusapiUrl?string | undefined

plusminusclientIdrequiredstring

plusminusconfigWhenDeniedrequiredRecord<string, unkno...

plusminusconfigWhenGrantedrequiredRecord<string, unkno...

plusminusscriptUrl?string | undefined

plusminusalwaysLoad?boolean | undefined

plusminusanonymizeId?boolean | undefined

plusminusasync?boolean | undefined

plusminusattributes?any

plusminuscallbackOnly?boolean | undefined

plusminuscategoryrequiredHasCondition<AllCons...

plusminusdefer?boolean | undefined

plusminusfetchPriority?"high" | "low" | "au...

plusminusiabLegIntPurposes?{} | undefined

plusminusiabPurposes?{} | undefined

plusminusiabSpecialFeatures?{} | undefined

plusminusidrequiredstring

plusminusnonce?string | undefined

plusminusonBeforeLoad?((info: ScriptCallba...

plusminusonConsentChange?((info: ScriptCallba...

plusminusonError?((info: ScriptCallba...

plusminusonLoad?((info: ScriptCallba...

plusminuspersistAfterConsentRevoked?boolean | undefined

plusminussrc?string | undefined

plusminustarget?"head" | "body" | un...

plusminustextContent?string | undefined

plusminusvendorId?string | number | un...