Postmaster Tools API overview
The Postmaster Tools API allows you to gather metrics on bulk emails sent to
Gmail users and import data into, or merge that data with, other systems.
Metrics include the percentage of your email marked as spam by the user and
delivery errors. For a full explanation of the metrics provided by the
Postmaster Tools API, refer to Dashboards section of the
Postmaster Tools help center article.
High-level implementation steps
Follow these high-level steps to use this API:
- Set up an authentication domain, either the DKIM (d=) or SPF domain (Return-Path domain) that is used to authenticate your email.
- Set up the API:
- Create a project.
- Turn on the Postmaster Tools API.
- Set up credentials for the API.
- Create an OAuth2 token.
- Use the OAuth2 token and credentials to make API calls including verifying domains and retrieving metrics.
Next steps
To set up the authentication domain, proceed to
Set up authentication domain.
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-12-19 UTC.
[null,null,["Last updated 2024-12-19 UTC."],[[["The Postmaster Tools API provides insights into email metrics like spam rate and delivery errors for bulk emails sent to Gmail users."],["You can integrate the API with other systems to import or merge email data for further analysis."],["Implementation involves setting up an authentication domain, enabling the API, and using credentials to make API calls."],["Detailed information about the metrics can be found in the Postmaster Tools help center."]]],["The Postmaster Tools API provides metrics on bulk emails sent to Gmail users, including spam markings and delivery errors. To utilize the API, users must first set up an authentication domain (DKIM or SPF). Next, they must create a project, enable the API, set up credentials, and create an OAuth2 token. Finally, the API is used to verify domains and retrieve metrics using the credentials and the token. Refer to the Postmaster Tools help center for the full metrics details.\n"]]
