Getting Started

1. Sign Up

Create your free account at /signup. No credit card required for the free tier (up to 3 endpoints).

2. Add Your First Endpoint

After signing in, you'll see the onboarding wizard. Add your first endpoint:

• Enter your API URL (e.g., https://api.example.com/health)
• Choose HTTP method (GET, POST, etc.)
• Set check interval (1-60 minutes)
• Configure timeout (5-60 seconds)

{
  "url": "https://api.example.com/health",
  "method": "GET",
  "checkInterval": 300,  // 5 min
  "timeout": 10          // 10 sec
}

3. Monitor Dashboard

Once your endpoint is added, PulseAPI starts monitoring immediately. View:

• ✅ Real-time status (🟢 Up, 🔴 Down, 🟡 Slow)
• 📊 Response time charts (last 7 days)
• 📈 Uptime percentage (24h rolling window)
• 📋 Check history table (paginated, filterable)

4. Set Up Alerts

PulseAPI automatically sends email alerts for:

• 🚨 Downtime: 2 consecutive failures
• ✅ Recovery: Endpoint back online
• ⚠️ Slow Response: >2000ms (max 1/hour)

All alerts go to your signup email. Configure webhooks in Settings for external integrations.

5. Use the API

Programmatic access via API keys (found in Settings):

curl -H "X-API-Key: YOUR_API_KEY" \
  https://api.getpulseapi.belliel.com/endpoints

See API Reference for full endpoint list.

Need Help?

Have questions or feedback? Use the waitlist form to get in touch — we respond to every message during beta.