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…
Communication#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 10
domainStats
- POSTExecutes a batch of QueryDomainStats requests for multiple domains
/v2/domainStats:batchQueryExecutes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of…
domains
- GETRetrieves a list of all domains registered by you, along with their corresponding metadata
/v2/domains?pageSize=0&pageToken=stringRetrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and… - POST[Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account
/v2/domainsDeveloper Preview: Adds a domain to the user's account. Returns INVALID_ARGUMENT if a domain is not provided. Returns ALREADY_EXISTS if the domain is already… - POST[Developer Preview](https://developers.google.com/workspace/preview): Verifies a user's ownership of a domain at the…
/v2/:name:verifyDeveloper Preview: Verifies a user's ownership of a domain at the DNS level. Note that this is distinct from checking if the user has OWNER status within IRDB.
domains.users
- GET[Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a user that…
/v2/:nameDeveloper Preview: Retrieves detailed information about a user that has access to a domain. Returns NOT_FOUND if the user does not exist. - DELETE[Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain
/v2/:nameDeveloper Preview: Deletes a user from a domain. Returns NOT_FOUND if the user does not exist. - PATCH[Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain
/v2/:name?updateMask=stringDeveloper Preview: Updates a user for a domain. Only Owners and Admins can execute this RPC, only a user's domain permission will be allowed to be updated.… - GET[Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a domain.
/v2/:parent/users?pageSize=0&pageToken=stringDeveloper Preview: Lists the users that have access to a domain. - POST[Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a domain
/v2/:parent/usersDeveloper Preview: Creates a user, who has access to a domain. Returns INVALID_ARGUMENT if a user is not provided.
domains.domainStats
- POSTRetrieves a list of domain statistics for a given domain and time period
/v2/:parent/domainStats:queryRetrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED…
API details
- Base URL
https://gmailpostmastertools.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 4 scopes
An API key in the key query parameter - Operations
- 10 operations on 6 pathsPOST 5GET 3PATCH 1DELETE 1
- Main resources
- domains.users 5domains 3domainStats 1domains.domainStats 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Gmail Postmaster Tools API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Gmail Postmaster Tools API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Executes a batch of QueryDomainStats requests for multiple domains” (POST /v2/domainStats:batchQuery), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Communication and has 10 endpoints.
Who publishes the Gmail Postmaster Tools API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Gmail Postmaster Tools API?
Requests go to https://gmailpostmastertools.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Gmail Postmaster Tools API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 4 scopes; an API key in the key query parameter.
How many endpoints does the Gmail Postmaster Tools API have?
10 operations on 6 paths (5 POST, 3 GET, 1 PATCH, 1 DELETE). The largest groups are domains.users, domains, domainStats, domains.domainStats.
Is forking the Gmail Postmaster Tools API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.