REST Resource: domains.trafficStats

Resource: TrafficStats

Email traffic statistics pertaining to a specific date.

JSON representation 
{
  "name": string,
  "userReportedSpamRatio": number,
  "ipReputations": [
    {
      object (IpReputation)
    }
  ],
  "domainReputation": enum (ReputationCategory),
  "spammyFeedbackLoops": [
    {
      object (FeedbackLoop)
    }
  ],
  "spfSuccessRatio": number,
  "dkimSuccessRatio": number,
  "dmarcSuccessRatio": number,
  "outboundEncryptionRatio": number,
  "inboundEncryptionRatio": number,
  "deliveryErrors": [
    {
      object (DeliveryError)
    }
  ],
  "userReportedSpamRatioLowerBound": number,
  "userReportedSpamRatioUpperBound": number
}
Fields
name

string

The resource name of the traffic statistics. Traffic statistic names have the form domains/{domain}/trafficStats/{date}, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
userReportedSpamRatio

number

The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by DKIM.
ipReputations[]

object (IpReputation)

Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
domainReputation

enum (ReputationCategory)

Reputation of the domain.
spammyFeedbackLoops[]

object (FeedbackLoop)

Spammy Feedback loop identifiers with their individual spam rates. This metric only pertains to traffic that is authenticated by DKIM.
spfSuccessRatio

number

The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with SPF. Spoofed mail is excluded.
dkimSuccessRatio

number

The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with DKIM. Spoofed mail is excluded.
dmarcSuccessRatio

number

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

number

The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
inboundEncryptionRatio

number

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[]

object (DeliveryError)

Delivery errors for the domain. This metric only pertains to traffic that passed SPF or DKIM.
userReportedSpamRatioLowerBound

number

The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by DKIM.
userReportedSpamRatioUpperBound

number

The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by DKIM.

IpReputation

IP Reputation information for a set of IPs in a specific reputation category.

JSON representation 
{
  "reputation": enum (ReputationCategory),
  "ipCount": string,
  "sampleIps": [
    string
  ]
}
Fields
reputation

enum (ReputationCategory)

The reputation category this IP reputation represents.
ipCount

string (int64 format)

Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed SPF or DKIM.
sampleIps[]

string

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

string

Feedback loop identifier that uniquely identifies individual campaigns.
spamRatio

number

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 (DeliveryErrorClass),
  "errorType": enum (DeliveryErrorType),
  "errorRatio": number
}
Fields
errorClass

enum (DeliveryErrorClass)

The class of delivery error.
errorType

enum (DeliveryErrorType)

The type of delivery error.
errorRatio

number

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

 Get traffic statistics for a domain on a specific date.

list

 List traffic statistics for all available days.