Skip to content

Get risk API usage and analytics

Request

Retrieve usage statistics, trends, and risk analytics for the Risk Score API.

Information provided:

  • Current quota (used/limit/remaining/reset_at)
  • Top risk factors detected in your previews
  • Average risk score across all previews
  • Breakdown of risk categories (recipient/content/sender/behavior)
  • Block rate statistics

Use this to:

  • Monitor API quota consumption
  • Understand common risk patterns in your sends
  • Identify areas for improvement (e.g., "30% of risk from unverified senders")
  • Plan list cleaning or content optimization strategies
Security
ApiKeyAuth
curl -i -X GET \
  https://api.mailerlogic.net/api/v1/risk/stats \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Statistics retrieved successfully

Bodyapplication/json
enabledbooleanrequired

Whether risk API is enabled for this customer

Example:true
quotaobjectrequired
analyticsobject

Risk analytics across all previews this month

top_factorsArray of objects

Most common risk factors detected (top 5)

Example:
[
  {
    "reason_code": "disposable_medium_confidence",
    "count": 45,
    "percentage": 18.2
  },
  {
    "reason_code": "sender_not_verified",
    "count": 38,
    "percentage": 15.4
  },
  {
    "reason_code": "content_risk_medium",
    "count": 23,
    "percentage": 9.3
  }
]
Response
{
  "enabled": true,
  "quota": {
    "limit": 1000,
    "used": 247,
    "remaining": 753,
    "reset_at": "2025-02-01T00:00:00Z"
  },
  "analytics": {
    "total_previews": 247,
    "average_risk_score": 28.5,
    "would_block_count": 12,
    "would_block_percentage": 4.9,
    "breakdown": { … }
  },
  "top_factors": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}