Getting Started

Welcome to APIAssert! This guide will help you set up your first API monitor in just a few minutes.

Create Your First Monitor

1. Add an Endpoint

From your dashboard, click New Monitor and enter your API endpoint:

https://api.example.com/v1/health

Choose the HTTP method (GET, POST, PUT, PATCH, DELETE) and optionally add headers or a request body.

2. Configure Assertions

Assertions define what a "healthy" response looks like. Add one or more:

Type Example Description
Status Code status == 200 Check HTTP status
Response Time responseTime < 500ms Ensure fast responses
JSON Path $.data.active == true Validate response body
Header header.content-type contains json Check headers

3. Select Regions

Choose which regions to monitor from:

  • us-east - Virginia, USA
  • us-west - Oregon, USA
  • eu-west - Ireland
  • eu-central - Frankfurt, Germany
  • ap-south - Mumbai, India
  • ap-east - Singapore

We recommend selecting at least 2-3 regions for comprehensive coverage.

4. Set Check Frequency

How often should we check your endpoint?

  • 30 seconds - Critical APIs
  • 1 minute - Important APIs
  • 5 minutes - Standard monitoring
  • 15 minutes - Low-priority endpoints

Understanding Results

Once your monitor is running, you'll see:

  • Uptime percentage - Based on successful checks
  • Response time graph - P50, P95, P99 latencies
  • Regional breakdown - Performance by location
  • Incident timeline - When issues occurred

Configure Alerts

Don't miss an outage. Set up alerts via:

  • Slack - Real-time channel notifications
  • Email - Detailed incident reports
  • Discord - Team notifications
  • Webhooks - Custom integrations
  • PagerDuty - On-call escalation

Next Steps