GET /gpdomains/v2/aggregated/domains

GET 
gpdomains/v2/aggregated/domains

Returns monitored domains with average SPF, DKIM, and DMARC authentication success rates.

Query Parameters

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

limit string
Maximum number of items to return per request

sort string
Sort by domain, or by compliance (compliance puts healthy domains first; -compliance puts domains needing work first). Needs-work domains are ordered by the number of failing statuses.

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.

Returns

• dataarray
  Monitored domains and their average authentication success rates for the requested date range
  • idstring
    Unique identifier of the monitored domain entry
  • domainstring
    Monitored domain name
  • compliance_statsobject
    Google Postmaster compliance information for the monitored domain
    • spfobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • dkimobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • spf_and_dkimobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • dmarc_policyobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • dmarc_alignmentobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • message_formattingobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • dns_recordsobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • encryptionobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • user_reported_spam_rateobject
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
    • one_click_unsubscribe_verdictobject
      Google compliance verdict for one-click unsubscribe support
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
      • reasonstring
        Google-provided reason for the one-click unsubscribe compliance verdict
        Allowed values: REASON_UNSPECIFIED, NO_UNSUB_GENERAL, NO_UNSUB_SPAM_REPORTS, NO_UNSUB_PROMO_SPAM_REPORTS
    • honor_unsubscribe_verdictobject
      Google compliance verdict for honoring unsubscribe requests
      • statusstring
        Compliance state reported by Google
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
      • reasonstring
        Google-provided reason for the honor-unsubscribe compliance verdict
        Allowed values: REASON_UNSPECIFIED, NOT_HONORING, NOT_HONORING_TOO_FEW_CAMPAIGNS, NOT_HONORING_TOO_MANY_CAMPAIGNS
    • deliverability_status_verdictobject
      Google assessment of the domain's deliverability status
      • statusstring
        Current deliverability compliance state
        Allowed values: STATE_UNSPECIFIED, COMPLIANT, NEEDS_WORK
      • reasonstring
        Google-provided reason for the deliverability status
        Allowed values: REASON_UNSPECIFIED, MESSAGE_VOLUME_LOW, SMTP_ERRORS_HIGH, SENDER_NOT_COMPLIANT, SPAM_RATE_HIGH, USER_FEEDBACK_NEGATIVE, USER_FEEDBACK_LOW, USER_FEEDBACK_POSITIVE
  • deleted_atstring
    Timestamp when the monitored domain was deleted; present only for deleted domains
  • authentication_averageobject
    Average SPF, DKIM, and DMARC authentication success rates for the requested date range
    • auth_success_rate_spfnumber
      Average rate of messages that passed SPF authentication
    • auth_success_rate_dkimnumber
      Average rate of messages that passed DKIM authentication
    • auth_success_rate_dmarcnumber
      Average rate of messages that passed DMARC authentication
• 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