GET /gpdomains/v2/aggregated/compliance_requirements

GET 
gpdomains/v2/aggregated/compliance_requirements

Returns the current domain count for every observed requirement and compliance verdict

Query Parameters

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

• dataobject
  Current compliance counts
  • spfobject
    Current compliance counts for the SPF authentication requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • dkimobject
    Current compliance counts for the DKIM authentication requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • spf_and_dkimobject
    Current compliance counts for the Combined SPF and DKIM authentication requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • dmarc_policyobject
    Current compliance counts for the DMARC policy requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • dmarc_alignmentobject
    Current compliance counts for the DMARC alignment requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • message_formattingobject
    Current compliance counts for the Message formatting requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • dns_recordsobject
    Current compliance counts for the DNS records requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • encryptionobject
    Current compliance counts for the Encryption requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • user_reported_spam_rateobject
    Current compliance counts for the User-reported spam rate requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • one_click_unsubscribeobject
    Current compliance counts for the One-click unsubscribe requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • honor_unsubscribeobject
    Current compliance counts for the Honor unsubscribe requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance
  • deliverability_statusobject
    Current compliance counts for the Deliverability status requirement
    • COMPLIANTinteger
      Number of domains that comply with this requirement
    • NEEDS_WORKinteger
      Number of domains that do not comply with this requirement
    • STATE_UNSPECIFIEDinteger
      Number of domains for which Google has not reported compliance

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error