APIMonitor
Documentation

API Monitor Documentation

Everything you need to set up monitors, configure alerts, and understand your API health.

Getting Started

Welcome to API Monitor - a comprehensive SaaS platform for monitoring your APIs' health, performance, and reliability. This documentation will help you get started quickly and make the most of our platform.

What is API Monitor?

API Monitor is a monitoring solution for developers and DevOps teams who need to ensure their APIs are performing optimally. Our platform provides insights into API availability, uptime, and response times.

Key Features

  • HTTP Monitoring: Periodic health checks on your API endpoints
  • Email Alerting: Get notified via email when a monitor changes status
  • Performance Analytics: Uptime and response-time metrics with historical trends
  • Uptime Tracking: Review uptime over time for every monitor
  • Public Status Pages: Share a public status page per monitor with your users

Setup Guide

1. Creating Your First Monitor

  1. 1Navigate to the Monitors section in your dashboard
  2. 2Click the + New Monitor button
  3. 3Enter your API endpoint URL
  4. 4Select the HTTP method (GET, POST, PUT, DELETE, etc.)
  5. 5Configure monitoring frequency
  6. 6Set alert conditions (expected status code, keyword validation, alert on down, degraded, or recovery)
  7. 7Choose whether to receive email alerts
  8. 8Save your monitor

2. Understanding Monitor Types

HTTP/HTTPS Monitors

Monitors run HTTP checks against your API endpoint using a configured method (GET, POST, PUT, DELETE, etc.) and can validate the expected status code and an optional response keyword.

Advanced Features

Alert Conditions

Each monitor lets you define when it should alert:

  • Expected status code (alert when the response does not match)
  • Response keyword validation (check that a specific string appears in the response)
  • Alert on down, degraded, and recovery

When a condition is met or cleared, an email alert is sent and recorded in the Alerts section of the dashboard.

Notifications

Alerts are delivered by email (via Resend). SMS, Slack, and other notification channels are planned but not yet available.

Troubleshooting

Common Issues

Monitor Shows as Down But API Works

This can happen due to:

  • The response returned an unexpected status code
  • The expected keyword was not found in the response body
  • A network or DNS issue prevented the check from completing
  • A request timeout occurred

Solution: Review the alert details and adjust the monitor's expected status code, keyword, or timeout settings.

Receiving Too Many Alerts

To reduce alert noise:

  • Align the expected status code with what your API actually returns
  • Only enable the alert conditions you need
  • Pause the monitor if you expect a temporary outage

Getting Help

If you need additional assistance, contact us at support@api-monitor.com.

Frequently Asked Questions

How often can I monitor my APIs?

Checks are run in the background by a worker on a schedule you configure per monitor.

Where are checks run from?

Checks are made from our hosted background worker, so your endpoint must be reachable over the public internet.

Is my data secure and private?

Data is stored in a Supabase-managed PostgreSQL database, and accounts are secured with Supabase authentication.

Can I monitor internal/private APIs?

Because checks run from our hosted worker, the endpoint must be reachable over the public internet. For internal services, expose a health check endpoint publicly or route traffic through a tunnel.