To create a Seedlisting test, follow these steps:
Get available email provider hosts for seedlisting tests
Get available testing capacity per email provider host
To get all available email provider hosts for Seedlisting tests, use the API https://api-doc.emailconsul.com/get-seedlisting-workers-hosts. This API returns the list of email provider hosts that can be used in the hosts field when creating a Seedlisting test.
To get the available testing capacity per email provider host, use the API https://api-doc.emailconsul.com/get-seedlisting-workers-capacity. This API returns the current capacity for each email provider host. The capacity value shows how many emails can currently be used for a specific host.
Use this value as the maximum allowed indicator value for emails_per_iteration when creating a Seedlisting test.
Keep in mind that capacity can change over time, so it is better to request this API shortly before creating a Seedlisting test.
If emails_per_iteration exceeds the capacity during Seedlisting creation, the current maximum capacity will be used for the specific host.
To create a new Seedlisting test, use the API https://api-doc.emailconsul.com/post-seedlisting. This API creates a new Seedlisting test for the selected email provider hosts.
The check_type field defines how EmailConsul should identify and group emails that belong to this Seedlisting test. Available check_type values are TAG, H_TO, REF, and EXPRESS. See more about check_type
In the hosts field, pass the selected email provider hosts together with emails_per_iteration.
If emails_per_iteration exceeds the capacity during Seedlisting creation, the current maximum capacity will be used for the specific host.
After creating a Seedlisting test, the API response returns the Seedlisting info together with all related emails.
See more about Seedlisting lifecycle statuses and Seedlisting email statuses and processing
To export all emails into a CSV file, use the API https://api-doc.emailconsul.com/get-seedlisting-export-emails-by-id. This API returns a CSV file with all emails for the selected Seedlisting test, so the user can copy/paste all emails in one action.
On your backend, you can pipe this API response directly to the user request because the response is returned in chunks.
To get the list of Seedlisting tests, use the API https://api-doc.emailconsul.com/get-seedlisting. This API returns Seedlisting tests with related info.
To get information for a specific Seedlisting test, use the API https://api-doc.emailconsul.com/get-seedlisting-by-id. This API returns the Seedlisting test by its ID with all related info.
To stop an active Seedlisting test manually, use the API https://api-doc.emailconsul.com/post-seedlisting-terminate-by-id. This API terminates the selected Seedlisting test and changes its status to TERMINATED.
All emails related to the terminated Seedlisting that were not received before termination will be marked as NOT_RECEIVED.
Keep in mind that there is no way to return a Seedlisting test from TERMINATED back to ACTIVE. Use this API when you do not want to wait until the Seedlisting test is finished automatically.
See more about Seedlisting lifecycle statuses and Seedlisting email statuses and processing
To get information for a specific Seedlisting email, use the API https://api-doc.emailconsul.com/get-seedlisting-seedlisting-email-by-id. This API returns a specific Seedlisting email by its ID with all related info.
To get aggregated Seedlisting statistics, use the API https://api-doc.emailconsul.com/get-seedlisting-stats-aggregated. This API returns grouped Seedlisting email stats by host, sender email, sender domain, IP and email status.
To get the total number of Seedlisting emails matching the selected filters, use the API https://api-doc.emailconsul.com/get-seedlisting-stats-emails-count. This API returns the count of Seedlisting emails based on the provided filters.
To get aggregated Authentication-Results statistics for Seedlisting emails, use the API https://api-doc.emailconsul.com/get-seedlisting-stats-auth-results. This API returns the total number of Seedlisting test emails matching the selected filters, together with aggregated SPF, DKIM, and DMARC pass/fail results.
To get Seedlisting statistics grouped by date and email delivery status, use the API https://api-doc.emailconsul.com/get-seedlisting-stats-timeseries. This API returns time-based Seedlisting email statistics matching the selected filters.
To create a public report for a specific Seedlisting test, use the API https://api-doc.emailconsul.com/post-seedlisting-public-reports. This API creates a publicly accessible report link for the selected Seedlisting test.
To get the public report settings for a specific Seedlisting test, use the API https://api-doc.emailconsul.com/get-seedlisting-public-report-by-id. This API returns the public report configuration for the selected Seedlisting test.
To delete a public report for a specific Seedlisting test, use the API https://api-doc.emailconsul.com/delete-seedlisting-public-report-by-id. This API permanently deletes the selected Seedlisting public report.
The check_type defines how EmailConsul identifies emails that belong to a specific Seedlisting test.
REF — To identify your email seed campaign, we use a catch email address, which is unique for a specific seed test you create. You must use this catch email address with your seed test email campaign so we can accurately tie your results back.
TAG — To identify your email seed campaign, we use a tag, which is unique for a specific seed test you create. You must add the tag into your HTML code before you send a seed test campaign. You must use this tag so we can accurately tie your results back.
H_TO — To identify your email seed campaign, we use a CC email address, which is unique for a specific seed test you create. You must include the CC email address and put it into the CC email field before you send a seed test. You must use this CC email with each email address so we can accurately tie your results back.
EXPRESS — Automatically groups received emails by subject and To header within a one-hour window. Express tests do not track unreceived emails. See more in the User Guide
For the EXPRESS check type, you do not need to create a new Seedlisting test each time. You can configure the EXPRESS email list once and send as many tests as needed.
EmailConsul analyzes the email subject and the To header, then groups received emails with the same subject within a one-hour window.
If multiple emails with the same subject are received within one hour, they are stored in the same Seedlisting test. If one hour has passed since the first received email and another email with the same subject is received, a new test is created.
The Express test does not track unreceived emails.
See more in the User Guide
Let’s focus on Seedlisting statuses that reveal the Seedlisting life cycle. Seedlisting can have the following statuses:
INIT — when Seedlisting has been created but related Seedlisting emails have not been created yet. Usually, this status stays for no more than a couple of seconds.
ACTIVE — indicates that Seedlisting is still waiting for emails. Seedlisting can be ACTIVE no more than 96 hours, even if related emails have not been received yet. Keep in mind, that after Seedlisting has been created with all related Seedlisting emails, there is no way to get back credits that were used for this Seedlisting. That being said if 96 hours passes and some or even all emails have not been received, Seedlisting status will be set to DONE and no used credits will be returned to the user.
DONE — Seedlisting stops receiving emails. Seedlisting can be set to DONE if all emails have been received or 96 hours have passed since it was created. If any emails for this Seedlisting are not received then they will be ignored. There is way to return back Seedlisting test from DONE to ACTIVE.
FAILED — if something goes wrong. Equals to DONE.
TERMINATED — indicates that the user stopped the Seedlisting process manually. There is no way to return a Seedlisting test from TERMINATED to ACTIVE.
Keep in mind that even if Seedlisting status is DONE, it does not mean that all processes related to the Seedlisting are done. You have to rely on the status and processing_status fields in every email (see the emails field in Seedlisting).
status in every email can have the following values:
WAITING — indicates that the email has not been received yet.
INBOX — fell into inbox.
SPAM — fell into spam.
NOT_RECEIVED — email has not been received and will not be, because the Seedlisting timeout is over, or Seedlisting is terminated or failed.
processing_status in every email can have the following values:
WAITING — indicates that the email has not been processed yet.
DONE — email has been fully processed.
NOTE: processing_status will be frozen in WAITING if an email status is NOT_RECEIVED.
Therefore, rely on the Seedlisting status field together with the status and processing_status fields in all related emails. If all are DONE, Seedlisting is fully processed and populated with all necessary data like dkim, dmarc, from, ips, spf and all necessary data for emails. All this information populates throughout processing.