Gmail Postmaster Tools API
Stay organized with collections
Save and categorize content based on your preferences.
The Postmaster Tools 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
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make 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 might 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
| Methods |
get |
GET /v1/{name=domains/*}
Gets a specific domain registered by the client. |
list |
GET /v1/domains
Lists the domains that have been registered by the client. |
| Methods |
get |
GET /v1/{name=domains/*/trafficStats/*}
Get traffic statistics for a domain on a specific date. |
list |
GET /v1/{parent=domains/*}/trafficStats
List traffic statistics for all available days. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# Gmail Postmaster Tools API\n\nThe Postmaster Tools 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.\n\n- [REST Resource: v1.domains](#v1.domains)\n- [REST Resource: v1.domains.trafficStats](#v1.domains.trafficStats)\n\nService: gmailpostmastertools.googleapis.com\n--------------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://gmailpostmastertools.googleapis.com`\n\nREST Resource: [v1.domains](/workspace/gmail/postmaster/reference/rest/v1/domains)\n----------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [get](/workspace/gmail/postmaster/reference/rest/v1/domains/get) | `GET /v1/{name=domains/*}` Gets a specific domain registered by the client. |\n| [list](/workspace/gmail/postmaster/reference/rest/v1/domains/list) | `GET /v1/domains` Lists the domains that have been registered by the client. |\n\nREST Resource: [v1.domains.trafficStats](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats)\n------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [get](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/get) | `GET /v1/{name=domains/*/trafficStats/*}` Get traffic statistics for a domain on a specific date. |\n| [list](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list) | `GET /v1/{parent=domains/*}/trafficStats` List traffic statistics for all available days. |"]]
