GET /gpdomains

GET 
gpdomains

Retrieve Google Postmaster data for monitored domains within a specified time period

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. 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

hide_without_stats boolean
hide all domains without trafficStats

include_deleted boolean
include deleted domains in results

Returns

• dataarray
  • idstring
    Unique identifier of the Google Postmaster domain entry
  • domainstring
    The monitored domain name
  • deleted_atstring
    Timestamp when the domain was deleted. Present only for deleted domains
  • traffic_statsarray
    List of traffic statistics records
    • keystring
      Key identifying this traffic stats record
    • domainstring
      The domain name associated with this traffic stats entry
    • date_timestampstring
      Timestamp of the traffic stats entry
    • ipReputationsarray
      Breakdown of sending IP reputations grouped by reputation category
      • reputationstring
        IP reputation category as reported by Google Postmaster
        Allowed values: REPUTATION_CATEGORY_UNSPECIFIED, HIGH, MEDIUM, LOW, BAD
      • ipCountstring
        Number of IPs with this reputation category
      • sampleIpsarray
        Sample list of IP addresses in this reputation category
    • domainReputationstring
      Overall domain reputation as reported by Google Postmaster
      Allowed values: REPUTATION_CATEGORY_UNSPECIFIED, HIGH, MEDIUM, LOW, BAD
    • spammyFeedbackLoopsarray
      List of spammy feedback loop identifiers and their spam ratios for this domain
      • idstring
        Feedback loop identifier
      • spamRationumber
        Ratio of messages flagged as spam
    • userReportedSpamRationumber
      Ratio of messages reported as spam by users
    • userReportedSpamRatioLowerBoundnumber
      Lower bound of the user-reported spam ratio confidence interval
    • userReportedSpamRatioUpperBoundnumber
      Upper bound of the user-reported spam ratio confidence interval
    • spfSuccessRationumber
      Ratio of messages that passed SPF authentication
    • dkimSuccessRationumber
      Ratio of messages that passed DKIM authentication
    • dmarcSuccessRationumber
      Ratio of messages that passed DMARC authentication
    • outboundEncryptionRationumber
      Ratio of outbound messages delivered over an encrypted connection
    • inboundEncryptionRationumber
      Ratio of inbound messages received over an encrypted connection
    • deliveryErrorsarray
      List of delivery errors encountered during the reporting period
      • errorClassstring
        Classification of the delivery error
        Allowed values: DELIVERY_ERROR_CLASS_UNSPECIFIED, PERMANENT_ERROR, TEMPORARY_ERROR
      • errorTypestring
        Specific type of delivery error
        Allowed values: DELIVERY_ERROR_TYPE_UNSPECIFIED, RATE_LIMIT_EXCEEDED, SUSPECTED_SPAM, CONTENT_SPAMMY, BAD_ATTACHMENT, BAD_DMARC_POLICY, LOW_IP_REPUTATION, LOW_DOMAIN_REPUTATION, IP_IN_RBL, DOMAIN_IN_RBL, BAD_PTR_RECORD
      • errorRationumber
        Ratio of messages affected by this delivery error type
• 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