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',
  options: {
    trackScreenViews: true,
    trackOutgoingLinks: 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 options parameter allows you to customize Databuddy's behavior:

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
  options: {
    // 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)
  },
});

Types

DatabuddyConsentOptions

Property

Types

Loading…

Script

Property

Types

Loading…

Databuddy

Script Implementation

Adding the Databuddy script to c15t

Using Databuddy in your application

How Consent Management Works

Configuration Options

Types

DatabuddyConsentOptions

apiUrl?Your Databuddy API URL.string | undefined

clientIdYour Databuddy client ID.requiredstring

options?Additional configuration options for Databuddy.Record<string, unknown>

script?Override or extend the default script values. Default values: id: 'databuddy' category: 'measurement' Partial<Script>

scriptUrl?The Databuddy script URL.string | undefined

Script

anonymizeId?Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockersboolean | undefined

async?Whether to use async loadingboolean | undefined

attributes?Additional attributes to add to the script elementRecord<string, string>

categoryConsent category or condition required to load this scriptrequiredHasCondition<AllConsentNames>

defer?Whether to defer script loadingboolean | undefined

fetchPriority?Priority hint for browser resource loading"high" | "low" | "auto" | undefined

iabLegIntPurposes?IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.{} | undefined

iabPurposes?IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.{} | undefined

iabSpecialFeatures?IAB TCF special feature IDs this script requires. Special features require explicit opt-in: 1: Use precise geolocation data 2: Actively scan device characteristics for identification {} | undefined

idUnique identifier for the scriptrequiredstring

nonce?Content Security Policy noncestring | undefined

onBeforeLoad?Callback executed before the script is loaded((info: ScriptCallbackInfo) => void) | u...

onConsentChange?Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.((info: ScriptCallbackInfo) => void) | u...

onError?Callback executed if the script fails to load((info: ScriptCallbackInfo) => void) | u...

onLoad?Callback executed when the script loads successfully((info: ScriptCallbackInfo) => void) | u...

persistAfterConsentRevoked?Whether the script should persist after consent is revoked.boolean | undefined

src?URL of the script to loadstring | undefined

textContent?Inline JavaScript code to executestring | undefined

vendorId?IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over category when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.string | number | undefined

apiUrl?Your Databuddy API URL.string | undefined

clientIdYour Databuddy client ID.requiredstring

options?Additional configuration options for Databuddy.Record<string, unknown>

script?Override or extend the default script values. Default values: id: 'databuddy' category: 'measurement' Partial<Script>

scriptUrl?The Databuddy script URL.string | undefined

anonymizeId?Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockersboolean | undefined

async?Whether to use async loadingboolean | undefined

attributes?Additional attributes to add to the script elementRecord<string, string>

categoryConsent category or condition required to load this scriptrequiredHasCondition<AllConsentNames>

defer?Whether to defer script loadingboolean | undefined

fetchPriority?Priority hint for browser resource loading"high" | "low" | "auto" | undefined

iabLegIntPurposes?IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.{} | undefined

iabPurposes?IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.{} | undefined

iabSpecialFeatures?IAB TCF special feature IDs this script requires. Special features require explicit opt-in: 1: Use precise geolocation data 2: Actively scan device characteristics for identification {} | undefined

idUnique identifier for the scriptrequiredstring

nonce?Content Security Policy noncestring | undefined

onBeforeLoad?Callback executed before the script is loaded((info: ScriptCallbackInfo) => void) | u...

onConsentChange?Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.((info: ScriptCallbackInfo) => void) | u...

onError?Callback executed if the script fails to load((info: ScriptCallbackInfo) => void) | u...

onLoad?Callback executed when the script loads successfully((info: ScriptCallbackInfo) => void) | u...

persistAfterConsentRevoked?Whether the script should persist after consent is revoked.boolean | undefined

src?URL of the script to loadstring | undefined

textContent?Inline JavaScript code to executestring | undefined

vendorId?IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over category when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.string | number | undefined

consentsThe current consent staterequiredRecord<AllConsentNames, boolean>

element?The script element (for load/error callbacks) Will be undefined for callback-only scriptsHTMLScriptElement

elementIdThe actual DOM element ID used (anonymized if enabled)requiredstring

error?Error information (for error callbacks)Error

hasConsentHas consentrequiredboolean

idThe original script IDrequiredstring

consentsThe current consent staterequiredRecord<AllConsentNames, boolean>

element?The script element (for load/error callbacks) Will be undefined for callback-only scriptsHTMLScriptElement

elementIdThe actual DOM element ID used (anonymized if enabled)requiredstring

error?Error information (for error callbacks)Error

hasConsentHas consentrequiredboolean

idThe original script IDrequiredstring

consentsThe current consent staterequiredRecord<AllConsentNames, boolean>

element?The script element (for load/error callbacks) Will be undefined for callback-only scriptsHTMLScriptElement

elementIdThe actual DOM element ID used (anonymized if enabled)requiredstring

error?Error information (for error callbacks)Error

hasConsentHas consentrequiredboolean

idThe original script IDrequiredstring

consentsThe current consent staterequiredRecord<AllConsentNames, boolean>

element?The script element (for load/error callbacks) Will be undefined for callback-only scriptsHTMLScriptElement

elementIdThe actual DOM element ID used (anonymized if enabled)requiredstring

error?Error information (for error callbacks)Error

hasConsentHas consentrequiredboolean