Skip to main content

GET /gpdomains/aggregated/user_reported_spam_ratio

GET 

gpdomains/aggregated/user_reported_spam_ratio

Retrieve aggregated average user-reported spam ratio grouped by monitored domain

Query Parameters

stats_date_from string Required
Start date for filtering statistics. Example: 2021-07-06T00:00:00.000Z

stats_date_to string Required
End date for filtering statistics. Example: 2021-08-06T00:00:00.000Z. The difference between stats_date_from and stats_date_to must not exceed 30 days

domain string
Filter results by a domain name substring

domain_reputations string
Filter results by domainReputation

profile_id string
Filter results by profile ID

ip string
Filter results by an IP address substring

Returns

  • dataarray
    List of average user-reported spam ratios aggregated per domain for the specified period
    • domainstring
      The monitored domain name
    • avgnumber
      Average user-reported spam ratio for this domain over the specified period
Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error