Help Center
Browse guides and FAQs for publishers and advertisers.
Getting Started
Install the SDK, initialize analytics, and send your first events in minutes.
How do I install the SDK?
Run `npm install @vexrail/sdk` and initialize with `new VexRail({ apiKey: process.env.VEXRAIL_KEY })`.
Do I need to change my LLM code?
No. Instrument analytics alongside existing LLM calls. You can keep your current providers and models.
What events should I send first?
Start with `prompt` and `response`. Add `impression`, `click`, and `conversion` later if you enable monetization.
SDK & Integration
Minimal configuration; client or server instrumentation both supported.
Where do I put my API key?
Use an environment variable (e.g., `.env.local`) and pass it to the SDK on initialization. Never hardcode secrets.
Is streaming supported?
Yes. Track prompts at initiation and responses after completion or at checkpoints for long streams.
Do you support exports and APIs?
Yes. Programmatically access clusters, scores, and placement guidance via REST/SDK exports.
Privacy & Security
Privacy-first by default: no PII, hashing, truncation, and retention controls.
What data is collected?
Truncated prompt text, hashed session IDs, optional response summaries, and optional monetization events. No PII.
How long is data retained?
Retention windows are configurable. You can request deletion and opt for shorter windows.
What is your role under DPAs?
We operate as a data processor. We provide tooling to help you meet your obligations as controller.
Monetization (Optional)
Turn on native monetization when you’re ready; analytics remains the core.
Do I need to show ads?
No. Analytics is independent. You can enable affiliate or contextual suggestions later.
How are bids/prices determined?
IntentScore™ combines external priors (keyword CPC/CPA) with observed CTR/CVR per intent and placement.
What controls do I have?
Placement exclusions, vertical/brand safety, and frequency caps. You can also disable monetization anytime.
Analytics & Reporting
Understand prompt intent clusters, value predictions, and placement guidance.
What is PromptGraph™?
A clustering view mapping keywords ↔ prompt variants ↔ entities to reveal user intent across your app.
What is IntentScore™?
A pricing guidance signal that blends priors with observed CTR/CVR to estimate eCPM/eCPA ranges.
Can I export reports?
Yes. Use the APIs/exports to retrieve clusters, scores, and recommended placements for your BI stack.
Billing & Accounts
Manage your plan and access keys; monetization is rev-share/CPA/CPC when enabled.
How is the analytics plan billed?
Publisher SDK is free in alpha. Pro/Enterprise plans add advanced analytics, APIs, and SSO.
How do monetization payouts work?
When enabled, payouts follow your rev-share/CPA/CPC terms. Payout timing and minimums are communicated in your dashboard.
Where do I rotate keys?
In your account settings. Generate, revoke, and rotate public/API keys without code changes.
Troubleshooting
Common integration issues and fixes.
Events are not appearing in the dashboard
Check network logs, verify `VEXRAIL_KEY`, ensure prompts are truncated and not blocked by CSP, and confirm time range filters.
High added latency
Batch non-critical events and ensure you’re using the latest SDK. Monetization calls are optional and can be deferred.
Unexpected clusters
Provide helpful `labels` on prompts and review entity extraction settings to guide clustering.
