DocsPricingCompareChangelogGitHub1,002
Start free
Integrations

Laravel

Add Databuddy's privacy-first analytics to your Laravel application by adding the tracking script to your main Blade layout file.

How to Add Databuddy to Laravel

1

Get Your Tracking Script

Get your Databuddy tracking script from your Databuddy dashboard. It will look like this:

html
<script
src="https://cdn.databuddy.cc/databuddy.js"
data-client-id="YOUR_CLIENT_ID"
async
></script>

Replace YOUR_CLIENT_ID with your actual Client ID from your Databuddy dashboard.

2

Locate Your Main Blade Layout File

In a standard Laravel application, you'll have a main layout file that other Blade views extend. This file is often located at:

  • resources/views/layouts/app.blade.php (common for applications using Laravel's authentication scaffolding)
  • Or resources/views/layouts/main.blade.php or a similar custom name
  • If you're using Laravel Jetstream or Breeze, the main layout file might be in a slightly different location within resources/views/

Identify the primary layout file that wraps most or all of your site's pages.

3

Add the Tracking Script to the Layout

Open your main Blade layout file. Paste the Databuddy tracking script just before the closing </body> tag.

resources/views/layouts/app.blade.phpphp
<!DOCTYPE html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>{{ config('app.name', 'Laravel') }}</title>
  {{-- Stylesheets, etc. --}}
  @vite(['resources/css/app.css', 'resources/js/app.js'])
</head>
<body class="font-sans antialiased">
  {{-- Your page content --}}
  @yield('content')

  {{-- Other scripts --}}

  {{-- Databuddy Analytics Script --}}
  @if(app()->environment('production'))
      <script
          src="https://cdn.databuddy.cc/databuddy.js"
          data-client-id="{{ config('services.databuddy.client_id') }}"
          async
      ></script>
  @endif
</body>
</html>

Explanation:

  • @if(app()->environment('production')): This Blade directive ensures the script is only included when your Laravel application is running in the production environment. This prevents tracking during local development.
  • {{ config('services.databuddy.client_id') }}: This accesses your Databuddy Client ID from Laravel's configuration system. See step 4 for .env configuration.

If you prefer not to use the config helper immediately, you can hardcode the value:

php
{{-- Databuddy Analytics Script --}}
@if(app()->environment('production'))
  <script
      src="https://cdn.databuddy.cc/databuddy.js"
      data-client-id="YOUR_CLIENT_ID"
      async
  ></script>
@endif

Remember to replace YOUR_CLIENT_ID with your actual Client ID.

4

Configure Environment Variables (Recommended)

It's best practice to store your Databuddy Client ID and server API key in your .env file and access them via Laravel's configuration.

a. Add to .env file: Open your .env file and add:

.envbash
DATABUDDY_CLIENT_ID=your-client-id-here
DATABUDDY_API_KEY=your-api-key-here
DATABUDDY_WEBSITE_ID=your-client-id-here

b. Add to config/services.php: Open (or create if it doesn't exist) config/services.php and add a configuration for Databuddy:

config/services.phpphp
<?php

return [
  // ... other services

  'databuddy' => [
      'client_id' => env('DATABUDDY_CLIENT_ID'),
      'api_key' => env('DATABUDDY_API_KEY'),
      'website_id' => env('DATABUDDY_WEBSITE_ID', env('DATABUDDY_CLIENT_ID')),
  ],
];

Now, the Blade template code from Step 3 using config('services.databuddy.client_id') will work correctly.

Make sure to run php artisan config:clear if you've cached your configuration.

5

Verify Integration

  • Deploy your Laravel application to your production environment (or set APP_ENV=production locally for testing, but be mindful of tracking local data)
  • Open your live Laravel website in a browser
  • Navigate through a few pages
  • Check your Databuddy dashboard for incoming data. It might take a few minutes for the first events to appear

Configuration Options

Enable additional tracking features by adding data attributes to your script tag:

php
{{-- Databuddy Analytics Script with Options --}}
@if(app()->environment('production'))
  <script
      src="https://cdn.databuddy.cc/databuddy.js"
      data-client-id="{{ config('services.databuddy.client_id') }}"
      data-track-attributes
      data-track-outgoing-links
      data-track-interactions
      data-track-performance
      data-track-web-vitals
      data-track-errors
      async
  ></script>
@endif

Custom Event Tracking

Track custom events from your Laravel Blade templates or JavaScript:

In Blade Templates

php
<button 
  onclick="if(window.databuddy) window.databuddy.track('button_click', { button_id: 'cta' })"
>
  Click Me
</button>

Using Data Attributes

Enable automatic tracking with data attributes:

php
{{-- Enable data-track attributes in script tag --}}
<script
  src="https://cdn.databuddy.cc/databuddy.js"
  data-client-id="{{ config('services.databuddy.client_id') }}"
  data-track-attributes
  async
></script>

{{-- Then use in your templates --}}
<button data-track="cta_click" data-button-type="primary">
  Get Started
</button>

<a href="/pricing" data-track="pricing_link_click" data-link-location="header">
  View Pricing
</a>

In JavaScript Files

If you're using Vite or Laravel Mix, you can track events from your JavaScript:

resources/js/app.jsjavascript
// Track custom events
function trackButtonClick(buttonId) {
  if (window.databuddy) {
      window.databuddy.track('button_click', {
          button_id: buttonId,
          page_path: window.location.pathname
      });
  }
}

// Track form submissions
document.addEventListener('DOMContentLoaded', function() {
  const forms = document.querySelectorAll('form[data-track]');
  forms.forEach(function(form) {
      form.addEventListener('submit', function() {
          if (window.databuddy) {
              window.databuddy.track('form_submit', {
                  form_type: form.getAttribute('data-form-type') || 'contact',
                  page_path: window.location.pathname
              });
          }
      });
  });
});

Server-Side Tracking

For server-side tracking in Laravel, use the Databuddy Node SDK or make HTTP requests directly:

bash
# Install HTTP client (Guzzle is included with Laravel)
# No additional package needed
app/Services/DatabuddyService.phpphp
<?php

namespace AppServices;

use IlluminateSupportFacadesHttp;

class DatabuddyService
{
  protected string $apiKey;
  protected ?string $websiteId;
  protected string $apiUrl;

  public function __construct()
  {
      $this->apiKey = config('services.databuddy.api_key');
      $this->websiteId = config('services.databuddy.website_id');
      $this->apiUrl = 'https://basket.databuddy.cc';
  }

  public function track(string $name, array $properties = []): void
  {
      Http::withToken($this->apiKey)->post("{$this->apiUrl}/track", [
          'name' => $name,
          'properties' => $properties,
          'websiteId' => $this->websiteId,
          'timestamp' => now()->toISOString(),
          'source' => 'server',
      ]);
  }
}

Then use it in your controllers:

php
use AppServicesDatabuddyService;

class OrderController extends Controller
{
  public function store(Request $request, DatabuddyService $databuddy)
  {
      // Process order...
      
      // Track order event
      $databuddy->track('order_placed', [
          'order_id' => $order->id,
          'total' => $order->total,
          'currency' => 'USD',
      ]);
      
      return redirect()->route('orders.show', $order);
  }
}

Common Use Cases

E-commerce Tracking

Track product views and purchases:

php
{{-- Product view page --}}
@push('scripts')
<script>
  if (window.databuddy) {
      window.databuddy.track('product_view', {
          product_id: '{{ $product->id }}',
          product_name: '{{ $product->name }}',
          price: {{ $product->price }},
          category: '{{ $product->category }}'
      });
  }
</script>
@endpush

Form Submissions

Track form submissions:

php
<form method="POST" action="{{ route('contact.store') }}" data-track="form_submit" data-form-type="contact">
  @csrf
  <!-- form fields -->
  <button type="submit">Submit</button>
</form>

Troubleshooting

Script Not Loading

  • Verify the script is in the correct Blade layout file
  • Check that APP_ENV=production in your .env file (or remove the @if condition for testing)
  • Check browser console for errors
  • Ensure your Client ID is correct in the config
  • Run php artisan config:clear if you've updated configuration

Events Not Tracking

  • Confirm window.databuddy exists before calling tracking methods
  • Check browser console for any errors
  • Verify events appear in your Databuddy dashboard after 2-3 minutes
  • Use browser dev tools Network tab to confirm requests are being sent

Environment-Specific Issues

  • The script only loads in production by default (due to @if(app()->environment('production')))
  • For local testing, temporarily remove the environment check or set APP_ENV=production in your .env
  • Remember to restore the environment check before deploying

Related Integrations

React

TypeScript support with React hooks and components.

Next.js

App Router and Pages Router support with SSR.

WordPress

Plugin or manual setup for WordPress sites.

Need help with your Laravel integration? Contact us at help@databuddy.cc.

How is this guide?

Edit on GitHub