WPE Usage Metrics User Guide

Overview

The WPE Usage Metrics addon displays usage metrics for your WP Engine-hosted sites directly in Local. View traffic, bandwidth, and storage information without leaving your development environment.

This addon uses the official WP Engine API (https://api.wpengineapi.com) to fetch metrics—the same API used by the WP Engine User Portal.

Requirements

• Local version 9.0.0 or higher
• Site must be connected to WP Engine (via Connect feature)
• WP Engine API credentials - Configure in Local Preferences → WP Engine Usage Metrics

Getting Started

1. Configure API Credentials

To authenticate with WP Engine:

1. Get your API credentials from my.wpengine.com/api_access
2. In Local, go to Preferences (Cmd+, on Mac, Ctrl+, on Windows)
3. Select WP Engine Usage Metrics from the sidebar
4. Enter your API Username and API Password
5. Click Test Connection to verify
6. Click Apply to save

Your credentials are stored securely in your system keychain.

2. Connect Your Site to WP Engine

If your site isn’t already connected:

1. Open your site in Local
2. Click Connect in the top-right corner
3. Sign in to your WP Engine account
4. Select the WP Engine environment to connect

3. View Usage Metrics

Once connected, the usage metrics panel appears automatically on the site overview page, showing:

Metric	Description
Visits	Total visits to your site
Billable Visits	Visits that count toward your plan
Total Bandwidth	Combined CDN and origin bandwidth
File Storage	Disk space used by files
Database Storage	Disk space used by database
Origin Requests	Requests served from origin server

4. Change Date Range

Use the dropdown in the top-right corner to select a date range:

• Last 7 days
• Last 30 days
• Last 60 days

5. Refresh Data

Click the Refresh button to fetch the latest metrics from WP Engine.

Understanding the Metrics

Traffic Metrics

• Visits: A visit is a series of page views from a single visitor within 30 minutes
• Billable Visits: Visits that count toward your WP Engine plan limits

Bandwidth Metrics

• Total Bandwidth: Sum of CDN and origin bandwidth
• Measured in bytes, displayed in human-readable format (KB, MB, GB)

Storage Metrics

• File Storage: Size of uploads, themes, plugins, and other files
• Database Storage: Size of your WordPress database
• Updated less frequently than traffic metrics

Troubleshooting

“Not authenticated” or “Configure API credentials”

You need to authenticate with WP Engine:

1. Go to Local Preferences → WP Engine Usage Metrics
2. Enter your API credentials from my.wpengine.com/api_access
3. Click Test Connection then Apply

“API Access is not enabled”

Your WP Engine account needs API access enabled:

1. Go to my.wpengine.com/api_access
2. Generate API credentials (username and password)
3. Configure them in Local Preferences → WP Engine Usage Metrics

Panel not showing

The metrics panel only appears for sites connected to WP Engine. Non-connected sites won’t show the panel.

Data shows zeros

• Check if the site has received traffic in the selected date range
• Storage metrics update less frequently and may show zero for new sites

Dark Mode

The addon automatically adapts to Local’s theme. Switch between light and dark mode in Local’s preferences.