Quick Start

Get your first API response in under 2 minutes.

1. Get Your API Key

# Create a key at: https://app.meetned.com/settings → Developer
# Your key looks like: ned_live_a1b2c3d4e5f6...

2. Test the Connection

curl -H "Authorization: Bearer ned_live_YOUR_KEY" \
  "https://api.meetned.com/api/v1/sales/analytics"

3. Explore Your Data

Sales Analytics

# Get sales summary for today
curl -H "Authorization: Bearer $NED_API_KEY" \
  "https://api.meetned.com/api/v1/sales/analytics?period=today"

# Get sales for the last 7 days
curl -H "Authorization: Bearer $NED_API_KEY" \
  "https://api.meetned.com/api/v1/sales/analytics?period=last_7_days"

Profitability

# Get profit summary
curl -H "Authorization: Bearer $NED_API_KEY" \
  "https://api.meetned.com/api/v1/profitability/summary?period=this_month"

Marketing Metrics

# Get marketing performance
curl -H "Authorization: Bearer $NED_API_KEY" \
  "https://api.meetned.com/api/v1/marketing/metrics?period=last_30_days"

4. Use the SDK (Recommended)

npm install @ned-ai/sdk

import { NedClient } from '@ned-ai/sdk';

const ned = new NedClient({ apiKey: process.env.NED_API_KEY });

// Get sales data
const sales = await ned.analytics.getSalesContext({ period: 'today' });
console.log(`Today's revenue: $${sales.summary.total_revenue}`);

// Get profitability
const profit = await ned.analytics.getProfitability({
  period: 'this_month',
  view_type: 'summary'
});
console.log(`Gross profit: $${profit.summary.gross_profit}`);

Available Periods

Period	Description
today	Current day
yesterday	Previous day
this_week	Current week (Mon-Sun)
last_week	Previous week
last_7_days	Rolling 7 days
this_month	Current month
last_month	Previous month
last_30_days	Rolling 30 days
this_quarter	Current quarter
last_quarter	Previous quarter
this_year	Current year
last_year	Previous year

Next Steps

• API Reference - All available endpoints
• SDK Guide - TypeScript SDK documentation
• MCP Integration - Connect to Claude Desktop