@datafast/web
v1.0.0
Published
DataFast analytics SDK for web apps
Maintainers
Readme
@datafast/web
DataFast analytics SDK for web apps. Use this if you prefer npm packages over the script tag.
Installation
npm install @datafast/webQuick Start
import { initDataFast } from '@datafast/web';
const datafast = initDataFast({
websiteId: 'your-website-id',
});
// Track page views
datafast.trackPageview();
// Track custom events
datafast.track('button_click', { button: 'signup' });
// Identify users
datafast.identify('user_123', { name: 'John', plan: 'pro' });
// Track payments
datafast.trackPayment('[email protected]');With React / Next.js
// lib/datafast.ts
import { initDataFast } from '@datafast/web';
export const datafast = initDataFast({
websiteId: 'your-website-id',
});
// In your component
import { datafast } from '@/lib/datafast';
function SignupButton() {
return (
<button onClick={() => datafast.track('signup_click')}>
Sign Up
</button>
);
}API
initDataFast(config)
const datafast = initDataFast({
websiteId: string, // Required: Your DataFast website ID
domain?: string, // Optional: Defaults to current hostname
apiUrl?: string, // Optional: Custom API endpoint
debug?: boolean, // Optional: Enable debug logging
});datafast.trackPageview()
Track a page view. Call this on route changes in SPAs.
datafast.track(eventName, properties?)
Track a custom event.
datafast.track('purchase', { product: 'Pro Plan', price: 99 });datafast.identify(userId, properties?)
Identify a logged-in user.
datafast.identify('user_123', { name: 'John', email: '[email protected]' });datafast.trackPayment(email, properties?)
Track a payment event.
datafast.trackPayment('[email protected]', { amount: 99, currency: 'USD' });datafast.reset()
Reset visitor identity (e.g., on logout).
Script Tag Alternative
If you prefer not to use npm, add the script tag instead:
<script src="https://datafa.st/script.js" data-website-id="your-website-id" async defer></script>License
MIT
