API Reference

Technical documentation for the GaugeWell platform APIs.

Base URLs

Authentication

All authenticated endpoints require a session token passed via cookie:

• Portal: portal_session cookie (set on login)
• Admin: admin_token cookie (set on login)

Unauthenticated requests return 401 Unauthorized.

Common Response Format

Success

{
  "ok": true,
  "data": { ... }
}

Error

{
  "error": "Human-readable error message",
  "status": 400
}

Paginated

{
  "data": [...],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 150,
    "totalPages": 8
  }
}

Rate Limiting

• Login endpoints: 5 attempts per 15-minute window
• API endpoints: 100 requests per minute per user
• Cron endpoints: Protected by x-vercel-cron header

Sections

• Authentication — Login, register, 2FA, sessions
• Billing — Subscriptions, invoices, Stripe portal
• Dashboard — KPIs, goals, ROI, action items
• Visibility & Analytics — Scores, competitors, AEO, listing health
• Content & CMS — Pages, templates, content suggestions
• 🔒 Admin API — Internal admin endpoints (requires admin access)