@sourcea/sdk
v0.1.0
Published
Sourcea browser SDK — lead attribution and conversion tracking.
Maintainers
Readme
@sourcea/sdk
Sourcea browser SDK — lead attribution and conversion tracking.
Captures UTM parameters, click IDs (gclid, fbclid), the GA4 client_id,
the document referrer and the landing page URL on every session, and ships
them to your Sourcea workspace alongside lead form submissions.
Install
npm install @sourcea/sdk
# or
pnpm add @sourcea/sdk
# or
yarn add @sourcea/sdkUsage (npm)
import { createSourcea } from '@sourcea/sdk';
const sourcea = createSourcea({
apiKey: 'sk_live_...',
// apiUrl: 'https://api.sourcea.io', // default
});
// Capture attribution + start a session.
await sourcea.trackSession();
// Track a custom event.
await sourcea.track('FORM_STARTED');
// Submit a lead.
await sourcea.sendLead(
{ email: '[email protected]', firstName: 'Jane' },
{ kind: 'demande_devis' },
);Usage (script tag)
The SDK ships a pre-built browser bundle. Drop it on any page:
<script src="https://cdn.jsdelivr.net/npm/@sourcea/sdk/dist/browser/sourcea.min.js"></script>
<script>
Sourcea.init({ apiKey: 'sk_live_...' });
Sourcea.trackSession();
</script>Or pin to a specific version:
<script src="https://cdn.jsdelivr.net/npm/@sourcea/[email protected]/dist/browser/sourcea.min.js"></script>API
createSourcea(config)→ returns an initialisedSourceaClient.client.init(config)— initialise an existing client.client.trackSession()— capture attribution + create a session.client.track(type, metadata?)— track an event.client.sendLead(contact, opts?)— submit a lead.captureAttribution(visitorId)— read attribution from the current page.getVisitorId(),getSessionId(),setSessionId()— storage helpers.
See the source for full type definitions.
License
MIT
