To integrate EmailConsul with your SNDS Postmaster data, you need to obtain a key. See User Guide for SNDS Postmaster Monitoring - EmailConsul for instructions on how to get a key from SNDS Postmaster.
To add the key to EmailConsul, use the following API: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/post_snds_creds
Every key (creds) can have the following status:
ACTIVE - the info for this key will be fetched from SNDS Postmaster
TERMINATED - the key is not removed, but the info will NOT be fetched from SNDS Postmaster
FAILED - if the key does not work for any reason
To update the key status from ACTIVE to TERMINATED or vice versa, use the API https://api.emailconsul.com/api/v1.0/doc/#/SNDS/patch_snds_creds__id_
To get all added keys, use the API https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_creds
To delete a key from SNDS Postmaster integration, use the API https://api.emailconsul.com/api/v1.0/doc/#/SNDS/delete_snds_creds__id_
By default, the information synchronizes with SNDS Postmaster every 24 hours and retrieves data for the day before yesterday. In some cases, we may want to retrieve data from SNDS 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/#/SNDS/post_snds_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/#/SNDS/get_snds_history
Two types of data are retrieved from the SNDS Postmaster:
IP_STATUS: This contains information about each monitored IP's reputation, including whether the IP is blocked, its sending behavior, and any potential issues that could impact deliverability.
IP_DATA: This includes detailed traffic statistics such as the number of messages sent, complaint rates, and other relevant metrics that help assess the overall performance and health of the IPs.
To get the IP Status data, use the API: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_ip_status
Response item description:
To get the IP Status data, use the API: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_ip_data
Response item description:
To get the list of all IPs that were fetched from SNDS Postmaster, use the API: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_user_ips
To get the list of all RDNS associated with all IPs that were fetched from SNDS Postmaster, use the API: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_user_rdns
To get aggregated stats for SNDS Postmaster, use APIs:
All metrics: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_aggregated
By traps: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_aggregated_traps
By sample mail from: https://api.emailconsul.com/api/v1.0/doc/#/SNDS/get_snds_aggregated_sample_mail_from