API Reference
Complete API reference for the Bklit SDK
API Reference
Complete reference for all Bklit SDK functions and methods.
initBklit(options)
Initialize the Bklit SDK.
Parameters
interface BklitOptions {
projectId: string; // Required: Your project ID
apiKey: string; // Required: Your API token
apiHost?: string; // Optional: API endpoint URL
environment?: string; // Optional: 'development' | 'production'
debug?: boolean; // Optional: Enable debug logging
}Example
import { initBklit } from '@bklit/sdk';
initBklit({
projectId: 'your-project-id',
apiKey: 'your-api-key',
});Returns
void
window.trackPageView()
Manually trigger a page view tracking event.
Example
window.trackPageView();Use Cases
- Custom routing
- Manual page tracking
- SPA route changes
- Dynamic content loading
Returns
void
window.trackEvent(trackingId, eventType, metadata?, triggerMethod?)
Manually trigger a custom event.
Parameters
- trackingId (
string, required) - Unique identifier for the event - eventType (
string, required) - Type of event ('click', 'view', 'hover', or custom) - metadata (
object, optional) - Additional data to attach - triggerMethod (
string, optional) - 'automatic' or 'manual' (default: 'manual')
Example
window.trackEvent(
'button-click',
'click',
{
buttonName: 'Sign Up',
location: 'header'
},
'manual'
);Returns
void
window.clearBklitSession()
Clear the current session (useful for testing).
Example
window.clearBklitSession();Use Cases
- Testing
- Debugging
- Session management
- User logout
Returns
void
Global Configuration
After initialization, configuration is available on window:
window.bklitprojectId // Your project ID
window.bklitApiHost // API host URL
window.bklitEnvironment // Environment mode
window.bklitDebug // Debug mode status
window.bklitApiKey // API key (if set)Error Handling
Initialization Errors
// Missing projectId
❌ Bklit SDK: projectId is required for initialization.
// Missing apiKey
❌ Bklit SDK: apiKey is required for initialization.Tracking Errors
// Invalid event
❌ Bklit SDK: Error tracking event: Invalid parameters
// API error
❌ Bklit SDK: API request failed: 401 UnauthorizedTypeScript Types
BklitOptions
interface BklitOptions {
projectId: string;
apiKey: string;
apiHost?: string;
environment?: 'development' | 'production';
debug?: boolean;
}Event Metadata
interface EventMetadata {
[key: string]: string | number | boolean | null;
}Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
- Mobile browsers
Requires ES6+ support.
Related Documentation
- Installation - Installing the SDK
- Configuration - Configuration options
- Event Tracking - Tracking events