Documentation

Everything you need to know about monitoring your APIs with APIShift

Quick Start

1. Create Your Account

Sign up for free - no credit card required. Get access to our Free plan with up to 5 APIs.

2. Add Your First API

Enter your API endpoint URL and optional authentication headers. We'll take an initial snapshot.

3. Configure Monitoring

Set your check frequency and notification preferences. Start receiving alerts for any changes.

Explore Documentation

Getting Started

Quick start guide to set up your first API monitor in minutes

  • Creating your account
  • Adding your first API
  • Understanding the dashboard
  • Setting up notifications
Learn more

API Configuration

Learn how to configure and optimize your API monitoring

  • Adding authentication headers
  • Custom request configuration
  • Managing multiple environments
  • Response filtering
Learn more

Alerts & Notifications

Configure multi-channel alerts to stay informed

  • Email notifications
  • Slack integration
  • Discord webhooks
  • Custom webhook endpoints
Learn more

Advanced Features

Unlock powerful monitoring capabilities

  • Schema diff algorithms
  • Historical comparisons
  • Custom monitoring rules
  • API health scores
Learn more

Security & Privacy

Understanding how we protect your data

  • Data encryption
  • Authentication security
  • GDPR compliance
  • Data retention policies
Learn more

Best Practices

Tips and strategies for effective API monitoring

  • Choosing check frequencies
  • Managing alert fatigue
  • Monitoring third-party APIs
  • Team collaboration workflows
Learn more

API Reference

Complete reference for integrating APIShift programmatically. Access monitoring data, manage APIs, and configure alerts via our REST API.

Authentication

Use API keys for secure authentication

Authorization: Bearer YOUR_API_KEY

Endpoints

  • • GET /api/monitors
  • • POST /api/monitors
  • • GET /api/changes
  • • POST /api/webhooks

Frequently Asked Questions

How does APIShift detect schema changes?

We use advanced diffing algorithms to compare the structure of API responses. This includes detecting field additions, removals, type changes, required/optional modifications, and nested object changes.

What happens when a change is detected?

When we detect a change, we immediately send notifications through your configured channels (email, Slack, Discord, webhooks). The change is categorized by severity (CRITICAL, HIGH, MEDIUM, LOW) and you can view detailed diffs in your dashboard.

Can I monitor APIs that require authentication?

Yes! You can add custom headers including Authorization tokens, API keys, or any other authentication method your API requires. All credentials are encrypted and stored securely.

How often are APIs checked?

Check frequency depends on your plan: Free plan offers hourly checks, Pro plan every 5 minutes, and Team plan offers real-time monitoring (every minute).

What if my API has sensitive data?

We only store the schema structure, not the actual data values. You can also use response filtering to exclude sensitive fields from monitoring.

Can I test the monitoring before going live?

Yes! Our Free plan is perfect for testing. You can add up to 5 APIs and see exactly how our monitoring works before upgrading.

Popular Integrations

📧

Email

Get instant email notifications for all API changes

Setup Guide
💬

Slack

Send alerts directly to your Slack channels

Setup Guide
🎮

Discord

Post notifications to Discord via webhooks

Setup Guide

Need Help?

Can't find what you're looking for? Our support team is here to help.