Live Traffic Alerts: Real-time API Monitoring

Runscope Traffic Alerts monitor your API calls and notify you and your team when specific conditions are met. Alerts are great for monitoring key API transactions in near real-time so that you can quickly respond to failed API calls. Traffic is easily collected using the Runscope traffic gateways located around the world, or behind the firewall with the gateway agent.

Live Traffic Alert Sample

Common use cases include:

  • Generating notifications when important API calls fail (e.g. payment APIs)
  • Keeping tabs on slow endpoints
  • SLA verification
  • Catching erroneous API calls so that you can retry them
  • Creating custom performance dashboards
  • Monitoring webhook callback URLs

Alerts are triggered using criteria you specify based on the HTTP request and response data for a given API call. These rules are evaluated after the request is completed (successfully or not). If a matching request is found, you are notified you via email, webhook or a connected service (Slack, HipChat, PagerDuty, etc.). Additional notifications will be sent for the 10th, 100th, 1,000th, and 10,000th matches.

For ongoing, proactive monitoring of API endpoints to validate functionality and measure uptime, use Runscope API Tests.


Create Your First Alert

If you haven't yet, sign up for your free Runscope account. Alerts are available to you and your team during your trial, and available to teams on qualified Runscope plans after your trial expires.

1. Create an Alert

Once signed into your account, go to Alerts and choose an alert template or create your own custom alert from scratch. For this example, we're going to look for API calls that return a 5xx class status code.

2. Add Rules

After creating an Alert, select the Edit icon to edit the criteria for a matching API call. You can evaluate the HTTP request and response headers, body data (JSON, XML, etc.) and connection info. Add a rule to check for a response status code between 500 and 599.

Live Traffic Alert Rules

3. Configure Notifications and Integrations

From the alert editor, choose the Emails tab and chose which people on your team should receive an email when the number of matches passes one of the thresholds.

If you have connected a messaging service to your Runscope account, you can enable notifications in the Integrations tab. Supported services include Slack, HipChat, Flowdock, Grove, PagerDuty and VictorOps.

4. Collect Traffic

Once your Alert is created, use a Gateway URL to collect traffic to evaluate against your criteria. When a match is encountered, Runscope will notify you via the configured channels. You can also collect traffic via the gateway agent (for private APIs), Runscope API (integrations with other services), or request captures (webhook calls).


Next Steps