SDK API Reference
Installation
Option 1: CDN Script Tag
Works with both Single-Page and Multi-Page Applications.
Auto-initialization (Recommended)
The SDK will automatically initialize when you provide the data-api-key attribute:
<script
src="https://cdn.luciaprotocol.com/lucia-sdk-latest.min.js"
data-api-key="your-api-key-here"
></script>
Optional configuration attributes:
data-api-key(required) - Your Lucia API keydata-debug-url(optional) - Custom debug endpoint URLdata-auto-track-clicks(optional) - Enable automatic click tracking ("true"or"false")data-track-selectors(optional) - Custom data-attributes or CSS selectors for click tracking (comma-separated)
Manual initialization
<script src="https://cdn.luciaprotocol.com/lucia-sdk-latest.min.js"></script>
<script>
LuciaSDK.init({
// API Key from https://ads.clickinsights.xyz
apiKey: 'your-api-key-here',
});
</script>
Option 2: npm/yarn (For more control or types when tracking)
npm install lucia-sdk
# or
yarn add lucia-sdk
import LuciaSDK from 'lucia-sdk';
await LuciaSDK.init({ // Init can be skipped if using CDN with data-api-key attribute
// Get your API Key from https://ads.clickinsights.xyz
apiKey: 'your-api-key-here',
});
Configuration Options
LuciaSDK.init({
apiKey: string; // Required: Your Lucia API key
debug?: boolean; // Optional: Enable debug mode
debugURL?: string; // Optional: Custom debug endpoint
autoTrackClicks?: boolean | {
enabled?: boolean;
selectors?: string[]; // CSS selectors to track
ignore?: string[]; // CSS selectors to ignore
};
});
Available Methods
| Method | Description |
|---|---|
init(config) | Initialize the SDK with your API key |
pageView(page) | Track a page view event |
trackConversion(tag, amount, details) | Track a conversion event |
buttonClick(button, metadata?) | Track button click events |
userInfo(userId, info) | Associate user information |
sendWalletInfo(address, chainId, walletName?) | Track wallet connections |
trackUserAcquisition(userId, data?) | Track user acquisition |
checkMetaMaskConnection() | Check MetaMask connection status |
VERSION | Get SDK version string |