Configuration Reference

import { Databuddy } from "@databuddy/sdk/react";

<Databuddy
// Required
clientId="your-client-id"

// API endpoints
apiUrl="https://basket.databuddy.cc"
scriptUrl="https://cdn.databuddy.cc/databuddy.js"

// Core tracking
trackPerformance        // default: true
trackWebVitals          // default: false
trackErrors             // default: false
trackOutgoingLinks      // default: false
trackScrollDepth        // default: false
trackInteractions       // default: false
trackAttributes         // default: false
trackHashChanges        // default: false

// Batching
enableBatching          // default: false
batchSize={10}          // 1-50
batchTimeout={2000}     // ms

// Retries
enableRetries           // default: true
maxRetries={3}
initialRetryDelay={500} // ms

// Sampling
samplingRate={1.0}      // 0.0-1.0

// Privacy
skipPatterns={["/admin/**", "/private/*"]}
maskPatterns={["/users/*", "/orders/**"]}

// Control
disabled={false}
debug={false}
waitForProfile={false}
/>

<script setup>
import { Databuddy } from "@databuddy/sdk/vue";
</script>

<template>
<Databuddy
  :client-id="clientId"
  :track-web-vitals="true"
  :track-errors="true"
  :enable-batching="true"
  :batch-size="20"
  :disabled="isDevelopment"
/>
</template>

<script
src="https://cdn.databuddy.cc/databuddy.js"
data-client-id="your-client-id"
data-track-web-vitals
data-track-errors
data-track-outgoing-links
data-track-scroll-depth
data-enable-batching
data-batch-size="20"
data-batch-timeout="2000"
data-sampling-rate="1.0"
data-skip-patterns='["/admin/**"]'
data-mask-patterns='["/users/*"]'
async
></script>

import { Databuddy } from "@databuddy/sdk/node";

const client = new Databuddy({
// Required
apiKey: process.env.DATABUDDY_API_KEY!,

// Optional: Scope events to a specific website
websiteId: process.env.DATABUDDY_WEBSITE_ID,

// Optional: Logical grouping (e.g., 'billing', 'auth', 'api')
namespace: "api",

// Optional: Source identifier (e.g., 'backend', 'webhook', 'cli')
source: "backend",

// API
apiUrl: "https://basket.databuddy.cc",

// Batching
enableBatching: true,       // default: true
batchSize: 10,              // max: 100
batchTimeout: 2000,         // ms
maxQueueSize: 1000,

// Deduplication
enableDeduplication: true,  // default: true
maxDeduplicationCacheSize: 10_000,

// Middleware
middleware: [
  (event) => {
    event.properties = { ...event.properties, server: true };
    return event;
  }
],

// Logging
debug: false,
logger: customLogger
});

import { databuddyLLM } from "@databuddy/sdk/ai";

const { track } = databuddyLLM({
// Authentication
apiKey: process.env.DATABUDDY_API_KEY,
apiUrl: "https://basket.databuddy.cc/llm",

// Features
computeCosts: true,      // default: true
privacyMode: false,      // default: false
maxContentSize: 1_048_576,  // 1MB

// Custom transport
transport: async (call) => {
  // Custom logging logic
},

// Callbacks
onSuccess: (call) => console.log("Success:", call.traceId),
onError: (call) => console.error("Error:", call.error)
});

import { FlagsProvider } from "@databuddy/sdk/react";

<FlagsProvider
clientId="your-client-id"
apiUrl="https://api.databuddy.cc"
user={{
  userId: "user-123",
  email: "user@example.com",
  organizationId: "org-456",
  teamId: "team-789",
  properties: {
    plan: "premium",
    role: "admin"
  }
}}
isPending={isLoadingSession}
disabled={false}
debug={false}
skipStorage={false}
autoFetch={true}
environment="production"
cacheTtl={60_000}
staleTime={30_000}
>
<App />
</FlagsProvider>

import { createServerFlagsManager } from "@databuddy/sdk/node";

const flags = createServerFlagsManager({
clientId: process.env.DATABUDDY_CLIENT_ID!,
apiUrl: "https://api.databuddy.cc",
user: {
  userId: "user-123"
},
environment: "production",
cacheTtl: 60_000,
staleTime: 30_000,
autoFetch: false,
debug: false,
disabled: false
});

NEXT_PUBLIC_DATABUDDY_CLIENT_ID=your-client-id
DATABUDDY_CLIENT_ID=your-client-id
DATABUDDY_API_KEY=your-api-key

VITE_DATABUDDY_CLIENT_ID=your-client-id

DATABUDDY_API_KEY=your-api-key
DATABUDDY_WEBSITE_ID=your-website-id  # Optional
DATABUDDY_API_URL=https://basket.databuddy.cc  # Optional