Google postmaster API

API link: Swagger UI

Add domains

NOTE: These methods are useful only as a part of the Manual Domain Addition Method (see User Guide for Google Postmaster integration - EmailConsul )

There are two ways to add domains to Google Postmaster monitoring:

All of these methods are upserting your domains, which means that if a domain is already added, it will not be added again, preventing duplication.

Get a list of domains with stats

To get a list of domains with stats, use the API https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains. This API returns the list of domains with all related info.

Response item description:

Get one domain with stats

To get one domain with Google Postmaster stats, use the Get List API (https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains) with the filter by domain

Delete one domain

To delete a domain from Google Postmaster integration, use https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/delete_gpdomains__id_.

Check the specific date

By default, the information synchronizes with Google Postmaster every 24 hours and retrieves data for the day before yesterday. In some cases, we may want to retrieve data from Google Postmaster for earlier dates or re-fetch data for existing ones (e.g., if there was a delay). In such scenarios, we can use https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/post_gpdomains_run, which initiates a sync job that may take a couple of minutes.

To view the history of all integration jobs, use the API: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_history

Available count API

Use https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_available_count to see how many domains can be added within the current Usage Plan.

Get time-series stats

To get the time-series stats for Google Postmaster, use APIs:

By domain reputation: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_timeseries_domain_reputation

By IP reputation: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_timeseries_ip_reputation

By user-reported spam ratio: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_timeseries_user_reported_spam_ratio

Get aggregated stats

To get aggregated stats for Google Postmaster, use APIs:

By user-reported spam ratio: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_aggregated_user_reported_spam_ratio

By feedback loop spam ratio: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_aggregated_feedback_loop_spam_ratio

By delivery errors ratio: https://api.emailconsul.com/api/v1.0/doc/#/Google%20postmaster/get_gpdomains_aggregated_delivery_errors_ratio