voidmark-analytics-sdk
v0.1.8
Published
First-party telemetry and SEO intelligence SDK for VoidMark AI
Readme
VoidMark Analytics SDK (voidmark-analytics-sdk)
"AI that identifies the empty spaces in your marketing strategy and fills them with data-driven campaigns."
VoidMark Analytics is a lightweight, framework-agnostic telemetry and SEO intelligence SDK. It collects SEO signals, user navigation behavior, Core Web Vitals, and content performance data to help you optimize your marketing strategy.
Features
- Traffic Reporting: Aggregated page views, sessions, and engagement metrics.
- SEO Score Analysis: Real-time DOM scanning for meta tags, titles, H1s, and more.
- User Path Tracking: Navigation flow, heatmaps (clicks), and frustration signals (rage clicks).
- Core Web Vitals: LCP, CLS, FID, INP, TTFB, and FCP monitoring.
- Content Performance: Engagement scores based on scroll depth, time on page, and activity.
- Framework Support: React, Next.js, Vite, and Vanilla JS.
- Privacy First: No cookies, no IP storage, and easy opt-out.
Installation
npm install voidmark-analytics-sdkQuick Start (React / Next.js)
- Create a
pathhunt.jsonin your project root. - Wrap your application with
VoidMarkProvider.
import { VoidMarkProvider } from 'voidmark-analytics-sdk/react';
export default function App({ children }) {
return (
<VoidMarkProvider siteKey={process.env.NEXT_PUBLIC_VOIDMARK_SITE_KEY}>
{children}
</VoidMarkProvider>
);
}Configuration (pathhunt.json)
The SDK requires a pathhunt.json file in the project root to control which paths are monitored.
{
"version": 1,
"siteKey": "vmk_live_...",
"paths": [
{
"path": "/",
"track": ["traffic", "seo", "vitals", "content"]
}
]
}Documentation
For detailed setup instructions, including backend ingestion, refer to the skill.md and BACKEND_SETUP.md files in the repository.
License
Proprietary — All rights reserved, VoidMark AI
