GET /gpdomains/v2/aggregated/spam_rate

GET 
gpdomains/v2/aggregated/spam_rate

Retrieve the average Google Postmaster v2 spam rate grouped by monitored domain across all or filtered Google Postmaster v2 monitored domains

Query Parameters

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

stats_date_from string Required
Start date for filtering statistics. Use date-time without timezone because Google Postmaster records are stored as calendar-date records with the timestamp set to the start of that day. Example: 2021-07-06T00:00:00.000Z. Do not send timezone offsets

stats_date_to string Required
End date for filtering statistics. Use date-time without timezone because Google Postmaster records are stored as calendar-date records with the timestamp set to the start of that day. Example: 2021-08-06T00:00:00.000Z. Do not send timezone offsets. The difference between stats_date_from and stats_date_to must not exceed 30 days

domain string
Filter Google Postmaster v2 domains by a domain name substring

profile_id string
Filter Google Postmaster v2 domains by profile ID

compliance string
Filter by domain compliance status. Accepts a comma-separated string or JSON array of values.

sort string
Sort field and order (for example, -avg for descending or domain for ascending)

Returns

• dataarray
  • domainstring
  • avgnumber
• metaobject
  Pagination metadata for list responses
  • countinteger
    Total number of items available
  • offsetinteger
    Number of items skipped
  • limitinteger
    Maximum number of items returned per request

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error