> ## Documentation Index
> Fetch the complete documentation index at: https://docs.promptguard.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Monitoring Dashboard
> Access security metrics, usage analytics, and configure policies via the PromptGuard dashboard
The PromptGuard dashboard provides programmatic access to security events, usage analytics, and configuration management. Access the dashboard at [app.promptguard.co](https://app.promptguard.co).
## Available Metrics
The dashboard provides access to the following data:
### Security Metrics
* **Total Interactions**: All API requests processed
* **Threats Flagged**: Security actions taken (blocked or redacted requests)
* **Detection Rate**: Percentage of requests flagged
* **Latency (p95)**: 95th percentile response time
* **Threat Breakdown**: Distribution by threat type (Prompt Injection, PII Detection, Jailbreak Attempts, Toxic Content, etc.)
### Alerts Feed
The Alerts page provides a real-time feed of security alerts with severity indicators and filtering:
* **Severity Levels**: High, medium, low - with visual indicators
* **Status Tracking**: Pending, acknowledged, dismissed states
* **Filtering**: Filter by severity, status, and date range
* **Badge Count**: Unread alert count shown in the navigation bar
Navigate to **Dashboard → Alerts** to access the feed.
### Threat Intelligence
The Threat Intelligence page surfaces cross-tenant, anonymized attack pattern data:
* **Attack Patterns**: Aggregated by threat type and mutation strategy
* **Evasion Rates**: Which bypass techniques beat which detectors
* **Trend Analysis**: How attack distributions shift over time
* **Attack Drift**: Visual chart of changing attack vectors
Available on Scale tier and above. Navigate to **Dashboard → Threat Intel**.
### Detector Performance
Per-detector accuracy, false positive rate, and latency metrics:
* **Accuracy**: True positive rate per detector
* **False Positive Rate**: How often benign requests are incorrectly flagged
* **Latency**: Processing time per detector
Navigate to **Projects → \[Your Project] → Detector Performance**.
### Compliance Reports
Interactive compliance reporting with framework-specific views:
* **Frameworks**: SOC 2, GDPR, HIPAA, OWASP LLM Top 10, OWASP Agentic Top 10
* **Controls Coverage**: Visual progress bars for each framework
* **Export**: Print to PDF or export as JSON
* **Time Periods**: 7, 30, or 90-day reporting windows
Navigate to **Dashboard → Compliance** or click "Executive Report" from the Overview.
### Usage Analytics
* **Request Counts**: Total requests, flagged requests (block + redact), flag rate
* **Usage vs. Limits**: Current usage against plan limits
* **Billing Period**: Days remaining and estimated monthly usage
* **Daily Usage**: Request volume over time
### Project Management
* **Multiple Projects**: Organize different applications or environments
* **Project-Specific**: Each project has its own API keys, policies, and analytics
* **Project Statistics**: Request counts and activity per project
## Configuration Options
### Security Rules
Configure security rules at the account or project level:
* **PII Detection**: Automatically detect and redact personally identifiable information
* **Prompt Injection Protection**: Block attempts to manipulate AI model behavior
* **Data Exfiltration Protection**: Prevent unauthorized access to system prompts
* **Toxicity Filter**: Filter harmful, offensive, or inappropriate content
* **Block Sensitive Data**: Automatically block requests containing sensitive information
* **Log All Requests**: Enable comprehensive request logging
### Policy Presets
Choose from predefined security presets optimized for different use cases:
* **Default**: Balanced security for general AI applications
* **Support Bot**: Optimized for customer support chatbots
* **Code Assistant**: Enhanced protection for coding tools
* **RAG System**: Maximum security for document-based AI
* **Data Analysis**: Strict PII protection for data processing
* **Creative Writing**: Nuanced content filtering for creative applications
### Notification Settings
Configure email alerts and notifications:
* **Email Alert Level**: All alerts, Critical only, or Off
* **Threat Alerts**: Enable/disable email notifications for security threats
* **Usage Alerts**: Enable/disable email notifications for usage milestones
### On-Demand Usage
Configure usage beyond plan limits:
* **Enable/Disable**: Toggle on-demand usage to allow requests beyond plan limits
* **Billing**: On-demand usage is billed in arrears (pay after use)
* **Spending Limits**: Set monthly spending limits (up to \$10,000/month or unlimited)
* **Enforcement**: Limits are enforced - requests are blocked when limit is exceeded
Spending limits are enforced. If you set a limit and exceed it, requests will be blocked until the next billing period or until you increase the limit.
## Feature Availability
### Analytics Export
* **Scale tier**: CSV export available
* **Free/Pro tiers**: View analytics only (no export)
### Security Testing
* **Available for**: Pro, Scale, and Tester tiers
* **Capabilities**: Run preset tests, custom tests, validate security configuration
### Data Exfiltration & Toxicity Filter
* **Available for**: All tiers
* **Detection**: Full ML-powered detection on all plans
### Developer Usage API
**Developer API Endpoint**: The usage stats endpoint below is part of the **Developer API** and is included in the OpenAPI spec. It uses API key authentication and is suitable for SDK usage.
Get usage statistics via developer API (requires API key):
```python theme={"system"}
import requests
import os
api_key = os.environ.get("PROMPTGUARD_API_KEY")
url = "https://api.promptguard.co/api/v1/usage/stats"
headers = {
"X-API-Key": api_key
}
response = requests.get(url, headers=headers)
if response.status_code == 200:
stats = response.json()
print(f"Requests this month: {stats.get('requests_this_month', 0)}")
print(f"Monthly limit: {stats.get('monthly_limit', 0)}")
print(f"Requests remaining: {stats.get('requests_remaining', 0)}")
print(f"Usage percentage: {stats.get('usage_percentage', 0):.1f}%")
else:
print(f"Error: HTTP {response.status_code}")
```
```typescript theme={"system"}
import fetch from 'node-fetch';
const apiKey = process.env.PROMPTGUARD_API_KEY;
const url = 'https://api.promptguard.co/api/v1/usage/stats';
const response = await fetch(url, {
headers: {
'X-API-Key': apiKey
}
});
if (response.status === 200) {
const stats = await response.json();
console.log(`Requests this month: ${stats.requests_this_month || 0}`);
console.log(`Monthly limit: ${stats.monthly_limit || 0}`);
console.log(`Requests remaining: ${stats.requests_remaining || 0}`);
console.log(`Usage percentage: ${(stats.usage_percentage || 0).toFixed(1)}%`);
} else {
console.error(`Error: HTTP ${response.status}`);
}
```
```bash theme={"system"}
# Get current usage statistics (developer API - requires API key)
curl https://api.promptguard.co/api/v1/usage/stats \
-H "X-API-Key: $PROMPTGUARD_API_KEY"
```
## Plan Tiers
### Free
* 10,000 requests/month
* Basic protection
* View analytics (no export)
### Pro
* \$99/month
* 100,000 requests/month
* All 14 security detectors
* Security Testing
* Analytics export not available
### Scale
* \$199/month
* 1M requests/month (soft limit)
* Advanced features
* Analytics CSV export
## Data Updates
* **Security events**: Real-time
* **Aggregated statistics**: Refresh every 5-15 minutes
* **Data retention**: Varies by plan tier
## Next Steps
Set up detailed usage analytics and tracking
Review detailed activity and security logs
Configure security policies and detection
Complete API documentation