--- title: Databuddy description: Databuddy is a privacy-focused analytics platform that helps you understand user behavior and track events. It supports cookieless tracking and manages consent automatically through c15t's consent state synchronization. lastModified: 2025-10-31 icon: databuddy --- The Databuddy script automatically respects consent preferences by toggling tracking on and off based on the user's consent state. ## Script Implementation 1. **Adding the Databuddy script to c15t** > ℹ️ Info: > > See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js). ```ts 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, } }) ``` 2. **Using Databuddy in your application** Once initialized, Databuddy is available globally via window\.databuddy or window\.db: ```ts // 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' }); ``` ## How Consent Management Works The Databuddy integration automatically handles consent management: 1. **Before Script Load**: Sets `window.databuddyConfig.disabled` based on initial consent state 2. **On Consent Grant**: Enables tracking by setting `window.databuddy.options.disabled = false` 3. **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: ```ts 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 | Type | Description | Default | Required | | :---------------- | :----------------------- | :-------------------------------------------------------------------- | :--------------------------------------- | :--------: | | clientId | string | Your Databuddy client ID. | - | ✅ Required | | apiUrl | string \| undefined | Your Databuddy API URL. | 'https\://basket.databuddy.cc' | Optional | | scriptUrl | string \| undefined | The Databuddy script URL. | 'https\://cdn.databuddy.cc/databuddy.js' | Optional | | configWhenGranted | Record\ | Databuddy config object to seed when consent is granted at load time. | - | ✅ Required | | configWhenDenied | Record\ | Databuddy config object to seed when consent is denied at load time. | - | ✅ Required | ### Script | Property | Type | Description | Default | Required | | :------------------------- | :------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :--------: | | id | string | Unique identifier for the script | - | ✅ Required | | src | string \| undefined | URL of the script to load | - | Optional | | textContent | string \| undefined | Inline JavaScript code to execute | - | Optional | | category | HasCondition\ | Consent category or condition required to load this script | - | ✅ Required | | callbackOnly | boolean \| undefined | 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: - Managing consent for libraries already loaded on the page - Enabling/disabling tracking features based on consent changes - Running custom code when consent status changes without loading external scripts Example use cases: - Enabling/disabling Posthog tracking - Configuring Google Analytics consent mode - Managing cookie consent for embedded content | false | Optional | | persistAfterConsentRevoked | boolean \| undefined | Whether the script should persist after consent is revoked. | false | Optional | | alwaysLoad | boolean \| undefined | Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management. | false | Optional | | fetchPriority | "high" \| "low" \| "auto" \| undefined | Priority hint for browser resource loading | - | Optional | | attributes | Record\ \| undefined | Additional attributes to add to the script element | - | Optional | | async | boolean \| undefined | Whether to use async loading | - | Optional | | defer | boolean \| undefined | Whether to defer script loading | - | Optional | | nonce | string \| undefined | Content Security Policy nonce | - | Optional | | anonymizeId | boolean \| undefined | Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers | true | Optional | | target | "head" \| "body" \| undefined | Where to inject the script element in the DOM. - \`'head'\`: Scripts are appended to \`\\` (default) - \`'body'\`: Scripts are appended to \`\\` Use \`'body'\` for scripts that: - Need to manipulate DOM elements that don't exist until body loads - Should load after page content for performance reasons - Are required by third-party services to be in the body Use \`'head'\` (default) for scripts that: - Need to track early page events (analytics) - Should be available before page render - Most tracking/analytics scripts | 'head' | Optional | | onBeforeLoad | ((info: ScriptCallbackInfo) => void) \| undefined | Callback executed before the script is loaded | - | Optional | | onLoad | ((info: ScriptCallbackInfo) => void) \| undefined | Callback executed when the script loads successfully | - | Optional | | onError | ((info: ScriptCallbackInfo) => void) \| undefined | Callback executed if the script fails to load | - | Optional | | onConsentChange | ((info: ScriptCallbackInfo) => void) \| undefined | Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded. | - | Optional | | vendorId | string \| number \| undefined | 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. | - | Optional | | iabPurposes | number\[] \| undefined | 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. | - | Optional | | iabLegIntPurposes | number\[] \| undefined | 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. | - | Optional | | iabSpecialFeatures | number\[] \| undefined | 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 | - | Optional |