Dashboard

API Usage Analytics

Location: Dashboard > API Analytics

The API Analytics dashboard provides detailed insights into your API usage patterns, request performance, and error rates. Use these tools to monitor integration health and optimize your verification workflows.

Table of Contents

Overview

API Analytics helps you understand:

Access: Dashboard > API Analytics

Analytics Dashboard

Summary Cards

The dashboard displays key metrics at a glance:

Metric Description
Total Requests API calls in selected period
Success Rate Percentage of successful requests
Avg Response Time Mean response time in milliseconds
Error Rate Percentage of failed requests

Charts

Request Volume Chart

Response Time Distribution

Error Breakdown

Product Usage

Request Logs

Detailed logs of individual API requests with full context.

Log Entry Fields

Field Description
Timestamp When the request was made
Endpoint API endpoint called
Method HTTP method (POST, GET, etc.)
Status Code HTTP response status
Response Time Time to process (ms)
API Key Key used (masked)
IP Address Origin IP (masked for privacy)
User Agent Client identifier
Error Message Details if request failed

Log Entry Example

2025-12-31 10:30:15 UTC
POST /api/verify
Status: 200 OK
Response Time: 1,250ms
API Key: vhk_live_****abcd
IP: 203.0.113.*
User Agent: Mozilla/5.0 (Python/requests)

Failed Request Details

For failed requests, additional context is provided:

2025-12-31 10:35:22 UTC
POST /api/verify
Status: 400 Bad Request
Response Time: 45ms
Error: No face detected in image
API Key: vhk_live_****efgh
Verification ID: ver_xyz789

Key Metrics

Performance Metrics

Metric Healthy Warning Critical
Avg Response Time < 2s 2-5s > 5s
P95 Response Time < 3s 3-8s > 8s
Success Rate > 95% 90-95% < 90%
Error Rate < 5% 5-10% > 10%

Error Categories

Category Description Common Causes
Client Errors (4xx) Invalid request Bad API key, missing params
Server Errors (5xx) Processing failed Provider issues, timeout
Validation Errors Invalid input Bad image format, too large
Rate Limit Too many requests Throttling triggered

Credit Efficiency

Metric Calculation
Credits per Success Total credits / Successful verifications
Waste Rate Failed credits / Total credits
Product Mix Cost Weighted average by product credit cost

Time Range Filters

Status Filters

Endpoint Filters

API Key Filters

Select specific API keys to analyze their individual performance.

Search logs by:

Dashboard data endpoints

The API Analytics page loads its data from two endpoints of the dashboard. They are authenticated by your dashboard sign-in session, not by an API key, and their response format follows the dashboard and may change. For programmatic reporting, use the Reporting API.

Endpoint Parameters
GET /dashboard/api/analytics/summary days — number of days to summarise (default 30)
GET /dashboard/api/analytics/logs page, per_page (default 50), endpoint, status, from, to

Best Practices

Monitoring

  1. Set up alerts for error rate spikes
  2. Check daily for unusual patterns
  3. Monitor response times for degradation
  4. Review failed requests regularly

Optimization

  1. Identify slow endpoints and optimize image sizes
  2. Reduce error rate by improving image capture
  3. Balance load across multiple API keys
  4. Cache results where appropriate

Troubleshooting

  1. Filter by error type to find patterns
  2. Check timestamps for incident correlation
  3. Review specific verification IDs for deep debugging
  4. Compare periods to identify regressions

Security

  1. Watch for unusual IPs making requests
  2. Monitor for rate limit hits (possible abuse)
  3. Check for 401 errors (invalid key usage)
  4. Review API key usage patterns

See Also