- Resource: TrafficStats
- IpReputation
- ReputationCategory
- FeedbackLoop
- DeliveryError
- DeliveryErrorClass
- DeliveryErrorType
- Methods
Resource: TrafficStats
Email traffic statistics pertaining to a specific date.
JSON representation |
---|
{ "name": string, "userReportedSpamRatio": number, "ipReputations": [ { object ( |
Fields | |
---|---|
name |
The resource name of the traffic statistics. Traffic statistic names have the form |
userReportedSpamRatio |
The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by DKIM. |
ipReputations[] |
Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except |
domainReputation |
Reputation of the domain. |
spammyFeedbackLoops[] |
Spammy Feedback loop identifiers with their individual spam rates. This metric only pertains to traffic that is authenticated by DKIM. |
spfSuccessRatio |
The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with SPF. Spoofed mail is excluded. |
dkimSuccessRatio |
The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with DKIM. Spoofed mail is excluded. |
dmarcSuccessRatio |
The ratio of mail that passed DMARC alignment checks vs all mail received from the domain that successfully authenticated with either of SPF or DKIM. |
outboundEncryptionRatio |
The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS). |
inboundEncryptionRatio |
The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed SPF or DKIM. |
deliveryErrors[] |
Delivery errors for the domain. This metric only pertains to traffic that passed SPF or DKIM. |
IpReputation
IP Reputation information for a set of IPs in a specific reputation category.
JSON representation |
---|
{
"reputation": enum ( |
Fields | |
---|---|
reputation |
The reputation category this IP reputation represents. |
ipCount |
Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed SPF or DKIM. |
sampleIps[] |
A sample of IPs in this reputation category. |
ReputationCategory
The reputation of a domain or IP. For more information see "Domain & IP Reputation Dashboards" in the Dashboards section on the Postmaster Tools help page page.
Enums | |
---|---|
REPUTATION_CATEGORY_UNSPECIFIED |
The default value which should never be used explicitly. This represents the state where no reputation information is available. |
HIGH |
Has a good track record of a very low spam rate, and complies with Gmail's sender guidelines. Mail will rarely be marked by the spam filter. |
MEDIUM |
Known to send good mail, but is prone to sending a low volume of spam intermittently. Most of the email from this entity will have a fair deliverability rate, except when there is a notable increase in spam levels. |
LOW |
Known to send a considerable volume of spam regularly, and mail from this sender will likely be marked as spam. |
BAD |
History of sending an enormously high volume of spam. Mail coming from this entity will almost always be rejected at SMTP level or marked as spam. |
FeedbackLoop
Feedback loop identifier information.
JSON representation |
---|
{ "id": string, "spamRatio": number } |
Fields | |
---|---|
id |
Feedback loop identifier that uniquely identifies individual campaigns. |
spamRatio |
The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier. |
DeliveryError
Metric on a particular delivery error type.
JSON representation |
---|
{ "errorClass": enum ( |
Fields | |
---|---|
errorClass |
The class of delivery error. |
errorType |
The type of delivery error. |
errorRatio |
The ratio of messages where the error occurred vs all authenticated traffic. |
DeliveryErrorClass
The class of delivery error.
Enums | |
---|---|
DELIVERY_ERROR_CLASS_UNSPECIFIED |
The default value which should never be used explicitly. |
PERMANENT_ERROR |
Delivery of message has been rejected. |
TEMPORARY_ERROR |
Temporary failure of message delivery to the recipient. |
DeliveryErrorType
The type of delivery error.
Enums | |
---|---|
DELIVERY_ERROR_TYPE_UNSPECIFIED |
The default value which should never be used explicitly. |
RATE_LIMIT_EXCEEDED |
The Domain or IP is sending traffic at a suspiciously high rate, due to which temporary rate limits have been imposed. The limit will be lifted when Gmail is confident enough of the nature of the traffic. |
SUSPECTED_SPAM |
The traffic is suspected to be spam, by Gmail, for various reasons. |
CONTENT_SPAMMY |
The traffic is suspected to be spammy, specific to the content. |
BAD_ATTACHMENT |
Traffic contains attachments not supported by Gmail. |
BAD_DMARC_POLICY |
The sender domain has set up a DMARC rejection policy. |
LOW_IP_REPUTATION |
The IP reputation of the sending IP is very low. |
LOW_DOMAIN_REPUTATION |
The Domain reputation of the sending domain is very low. |
IP_IN_RBL |
The IP is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your IP delisted. |
DOMAIN_IN_RBL |
The Domain is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your domain delisted. |
BAD_PTR_RECORD |
The sending IP is missing a PTR record. |
Methods |
|
---|---|
|
Get traffic statistics for a domain on a specific date. |
|
List traffic statistics for all available days. |