API Monitoring

Monitor your APIs and websites with scheduled uptime checks. Track response times, receive instant email alerts when endpoints go down, and maintain comprehensive statistics for all your monitored endpoints.

Features

• Scheduled Checks: Choose from 2, 5, 10, 15, 30, or 60 minute intervals
• Uptime Tracking: Monitor endpoint availability 24/7
• Response Time: Track how fast your endpoints respond
• Email Alerts: Instant notifications when endpoints go down
• Statistics Dashboard: View uptime percentage, total checks, and history
• Multiple Methods: Support for GET, POST, PUT, DELETE, PATCH
• Custom Headers: Add authentication or custom headers to requests
• Request Body: Send custom data with POST/PUT/PATCH requests

Use Cases

Creating a Monitor

Via Dashboard

1. Sign in to your APIVerve Dashboard
2. Navigate to VerveKit → API Monitoring
3. Click "Create New Monitor"
4. Configure your monitor:
   • Name: Descriptive name for the monitor
   • URL: Full endpoint URL to monitor (https://...)
   • HTTP Method: GET, POST, PUT, DELETE, or PATCH
   • Check Frequency: 2, 5, 10, 15, 30, or 60 minutes
   • Timeout: Maximum seconds to wait for response (default: 10)
   • Headers: Optional custom headers (JSON format)
   • Body: Optional request body for POST/PUT/PATCH
5. Click "Save" to create and start monitoring

Configuration Options

Check Frequencies

Available check intervals and estimated monthly token usage per monitor:

• 2 minutes: ~21,600 tokens/month (highly responsive)
• 5 minutes: ~8,640 tokens/month (recommended for production)
• 10 minutes: ~4,320 tokens/month (balanced monitoring)
• 15 minutes: ~2,880 tokens/month (frequent checks)
• 30 minutes: ~1,440 tokens/month (moderate monitoring)
• 60 minutes: ~720 tokens/month (basic monitoring)

HTTP Methods

Monitor endpoints using any HTTP method:

• GET: Most common for health checks and status endpoints
• POST: Monitor endpoints that require data submission
• PUT: Check endpoints that update resources
• PATCH: Monitor partial update endpoints
• DELETE: Check deletion endpoints (use with caution)

Success Criteria

A check is considered successful when:

• HTTP response status code is 2xx (200-299)
• Response received within timeout period
• No network or connection errors

Timeout Configuration

Set how long to wait for a response (default: 10 seconds):

• Fast APIs: 5-10 seconds
• Normal APIs: 10-15 seconds
• Slow APIs: 15-30 seconds

Custom Headers

Add authentication or custom headers in JSON format:

{
  "Authorization": "Bearer YOUR_TOKEN",
  "x-api-key": "your-api-key",
  "Content-Type": "application/json"
}

Request Body

For POST, PUT, or PATCH methods, send custom data:

{
  "healthCheck": true,
  "timestamp": "2024-01-01T12:00:00Z"
}

Monitoring Dashboard

View comprehensive statistics for each monitor:

Latest Status

• Status: Up or Down
• Last Check: Timestamp of most recent check
• Response Time: Latest response time in milliseconds
• Status Code: HTTP status code from last check

Statistics

• Uptime Percentage: Overall uptime percentage
• Total Checks: Total number of checks performed
• Successful Checks: Number of successful checks
• Failed Checks: Number of failed checks
• Average Response Time: Mean response time across all checks
• Total Tokens Used: Total token consumption for this monitor

Check History

View the last 100 checks with:

• Timestamp
• Status (up/down)
• Response time
• Status code
• Token cost

Email Alerts

When Alerts are Sent

You will receive an email alert when:

• A monitor that was up goes down
• Status code is not 2xx
• Request times out
• Network or connection error occurs

Alert Contents

Email alerts include:

• Monitor name
• Monitored URL
• Status code (if available)
• Error message
• Response time
• Timestamp
• Link to dashboard

Alert Email

Alerts are sent to the email address associated with your APIVerve account.

Token Billing

How Billing Works

• Standard Check: 1 token per successful or failed check
• Timeout: 2 tokens when request exceeds timeout
• Pre-Check Validation: Monitors are skipped if insufficient tokens available
• Real-Time Deduction: Tokens deducted immediately after each check

Token Requirements

Ensure your account has sufficient tokens:

• Minimum 2 tokens required before each check
• Monitors automatically skipped if token balance is low
• Monitors resume automatically when tokens are available

Estimating Costs

Calculate monthly token usage:

Monthly Tokens = (60 minutes / frequency) × 24 hours × 30 days

Examples:
- 2 min frequency: (60/2) × 24 × 30 = 21,600 tokens/month
- 5 min frequency: (60/5) × 24 × 30 = 8,640 tokens/month
- 10 min frequency: (60/10) × 24 × 30 = 4,320 tokens/month

Managing Your Monitors

Edit Monitor

Update monitor configuration:

1. Navigate to API Monitoring in your dashboard
2. Click Edit next to your monitor
3. Modify any settings (URL, frequency, timeout, etc.)
4. Click Save

Pause/Resume Monitor

1. Navigate to API Monitoring in your dashboard
2. Click Pause to temporarily stop monitoring
3. Click Resume to restart monitoring

Note: Paused monitors don't consume tokens.

Delete Monitor

1. Navigate to API Monitoring in your dashboard
2. Click Delete next to your monitor
3. Confirm the deletion

Best Practices

• Choose Appropriate Frequency: Balance monitoring needs with token costs
• Set Realistic Timeouts: Account for your endpoint's normal response time
• Use GET for Health Checks: Avoid side effects from POST/PUT/DELETE
• Monitor Critical Endpoints: Prioritize production and user-facing APIs
• Test Before Monitoring: Verify your endpoint works before creating a monitor
• Descriptive Names: Use clear names to identify monitors quickly
• Monitor Token Balance: Ensure sufficient tokens for continuous monitoring
• Review Statistics: Regularly check uptime percentage and response times
• Act on Alerts: Respond promptly when you receive down alerts

Troubleshooting

Monitor Shows Down (But Endpoint is Up)

• Check if endpoint requires authentication headers
• Verify timeout is sufficient for response time
• Ensure URL is correct and publicly accessible
• Check if endpoint blocks automated requests

Not Receiving Email Alerts

• Check spam/junk folder
• Verify email address in account settings
• Ensure monitor was previously up before going down
• Contact support if issue persists

Monitor Not Running

• Check if monitor is enabled (not paused)
• Verify sufficient token balance
• Check monitor schedule settings
• Review last check timestamp

High Token Usage

• Review check frequency - reduce if possible
• Check for timeout issues (2x token cost)
• Optimize endpoint response time
• Pause non-critical monitors temporarily

Limitations

• Minimum Frequency: 2 minutes (no faster checks available)
• Maximum Timeout: 30 seconds
• History Retention: Last 100 checks per monitor
• Paid Plans Only: Monitoring requires active paid subscription
• Public URLs Only: Cannot monitor localhost or private networks

Need Help?

• VerveKit Overview
• Quick Start Guide
• API Keys Documentation
• API Monitoring Dashboard
• Contact Support