Documentation - NeuralDash

Quick Start Guide

Get up and running with NeuralDash in under 5 minutes. This guide walks you through the essentials.

Create Your Account

Sign up for a free trial at neuraldash.io. No credit card required. You'll receive your API key upon registration.

Install the SDK

Install our JavaScript SDK with a single command:

npm install @neuraldash/sdk

Initialize the Client

Initialize NeuralDash with your API key:

import NeuralDash from '@neuraldash/sdk';

const client = new NeuralDash('your-api-key');

Track Your First Event

Start sending events to NeuralDash:

client.track('user_signed_up', {
  userId: 'user_123',
  email: 'sarah@example.com',
  plan: 'professional'
});
                                    

View Your Dashboard

Login to your dashboard at app.neuraldash.io to see your data in real-time. Your first events should appear within seconds.

Authentication

NeuralDash uses API keys for authentication. Each workspace has its own API key that you can regenerate at any time.

Your API Key

Find your API key in Settings → API Keys. It should look like this:

nd_live_abc123def456ghi789jkl012mno345pqr678

Making Authenticated Requests

Include your API key in the Authorization header:

curl -X GET "https://api.neuraldash.io/v1/events" \
  -H "Authorization: Bearer nd_live_abc123def456ghi789jkl012mno345pqr678" \
  -H "Content-Type: application/json"
                        

Security Best Practices

Never expose your API key in client-side code
Use environment variables to store your key
Regenerate keys immediately if compromised
Use separate keys for development and production

Events

Events are the foundation of NeuralDash analytics. Every user action, conversion, or system event can be tracked and analyzed.

Event Structure

Each event contains these properties:

event — The event name (e.g., "page_viewed")
userId — Unique user identifier
timestamp — When the event occurred
properties — Additional event data

Standard Events

We recommend tracking these standard events for most use cases:

// Page views
client.track('page_viewed', {
  page: '/pricing',
  referrer: 'https://google.com'
});

// User signups
client.track('user_signed_up', {
  plan: 'professional',
  source: 'organic'
});

// Purchases
client.track('purchase_completed', {
  orderId: 'order_456',
  total: 99.00,
  currency: 'USD'
});
                        

Dashboards

Dashboards display your data in meaningful ways. Learn how to create and customize them.

Creating a Dashboard

Navigate to Dashboards → New Dashboard. Choose from our template library or start with a blank canvas.

Available Widgets

Metrics — KPI cards with trend indicators
Charts — Line, bar, pie, and scatter plots
Tables — Sortable data tables
Funnels — Conversion funnel visualizations
Retention — Cohort retention tables

Sharing Dashboards

Share dashboards with team members or generate public links. Set permissions to control who can view or edit.

REST API Reference

Our REST API lets you manage all NeuralDash resources programmatically.

Base URL

https://api.neuraldash.io/v1

Endpoints

GET /events

Retrieve a list of events with optional filters.

POST /events

Track a new event.

GET /users

List all tracked users.

PUT /users/:id

Update user properties.

DELETE /users/:id

Permanently delete a user and their data.

Response Format

All responses return JSON with this structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 150
  }
}
                        

Webhooks

Webhooks let NeuralDash push data to your servers when events occur in real-time.

Setting Up Webhooks

Navigate to Settings → Webhooks → Add Webhook. Enter your endpoint URL and select events to subscribe to.

Webhook Events

user.created — New user registered
user.deleted — User deleted their account
goal.completed — User completed a goal
subscription.created — New subscription
subscription.cancelled — Subscription cancelled

Webhook Payload

{
  "event": "user.created",
  "timestamp": "2026-04-07T12:00:00Z",
  "data": {
    "userId": "user_123",
    "email": "sarah@example.com"
  }
}
                        

Changelog

Stay updated with the latest NeuralDash features and improvements.

v2.4.0 April 7, 2026 New

Added AI-powered anomaly detection with configurable sensitivity thresholds. New dashboard template: "Customer Health Score".

v2.3.5 March 28, 2026 Improved

Dashboard load times reduced by 40%. Enhanced mobile app performance. Better caching for large datasets.

v2.3.4 March 15, 2026 Fixed

Fixed timezone handling in scheduled reports. Resolved occasional dashboard freeze on Safari. API rate limit errors now include retry-after headers.

v2.3.0 March 1, 2026 New

Launched custom formula metrics. Added support for BigQuery direct queries. New Slack integration with @mention support.

Need Help?

Our support team is here to help you succeed with NeuralDash.

Documentation Resources

This documentation — Comprehensive guides and API reference
Help Center — Video tutorials and troubleshooting articles
Community Forum — Connect with other NeuralDash users
Status Page — Real-time system status and incident reports

Contact Support

Email us at support@neuraldash.io or use the in-app chat for priority assistance.