This documentation covers a Beta version of the Postmaster API.

Gmail Postmaster Tools API

The Gmail Postmaster API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.

Service: gmailpostmastertools.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://gmailpostmastertools.googleapis.com

REST Resource: v1beta1.domains

Methods
get GET /v1beta1/{name=domains/*}
Gets a specific domain registered by the client.
list GET /v1beta1/domains
Lists the domains that have been registered by the client.

REST Resource: v1beta1.domains.trafficStats

Methods
get GET /v1beta1/{name=domains/*/trafficStats/*}
Get traffic statistics for a domain on a specific date.
list GET /v1beta1/{parent=domains/*}/trafficStats
List traffic statistics for all available days.