Gmail Postmaster Tools API
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["The Postmaster Tools API offers programmatic access to email traffic metrics, such as spam reports and delivery errors, which are also accessible through the Gmail Postmaster Tools UI."],["It is a RESTful API with a service endpoint at `https://gmailpostmastertools.googleapis.com`."],["Developers can use Google-provided client libraries or their own to interact with the API."],["The API allows you to get and list domains registered by the client and get traffic statistics for domains on specific dates or list them for all available days."],["A Discovery Document is available for generating client libraries and other tools to interact with the Google API."]]],["The Postmaster Tools API, accessible via `gmailpostmastertools.googleapis.com`, provides programmatic access to email traffic metrics. It offers two REST resources: `v1.domains` and `v1.domains.trafficStats`. The `v1.domains` resource allows retrieving a specific domain using `get` or listing all registered domains with `list`. The `v1.domains.trafficStats` resource enables fetching traffic statistics for a domain on a specific date (`get`) or listing traffic data for all available days (`list`).\n"]]
