Get Email Status Data

Check status of emails in the list

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Guidelines

Time Period Requirements

  • Required: You must specify either startDate and endDate parameters, or the days parameter
  • Maximum duration: Time span cannot exceed 3 days
  • Date format: Use yyyy-MM-dd format for startDate and endDate

Pagination and Limits

  • Default limit: 100 records per search
  • Pagination: Use limit and start parameters when records exceed 100
  • Cache duration: Each query result is cached for 10 minutes

Rate Limiting

  • Maximum calls: 60 requests per minute per user account
  • Exceeded limit response: {"result": false, "statusCode": 50000, "message": "interface frequency limited", "info": {}}

Status Parameters

  • Valid status values: sending, delivered, suppressed, hard_bounce, soft_bounce
  • Label priority: When both labelId and labelName are provided, labelId takes precedence for accurate queries
  • Label search: Use labelName alone for fuzzy search functionality

Status Codes Reference

Detailed Status Mapping

StatusSub StatusSub Status Description
hard_bounce403Server Unreachable
hard_bounce404Address Format Error
hard_bounce405IP, Domain Name Rejected
hard_bounce406Address Does Not Exist
hard_bounce407Spam
hard_bounce408Sender/Recipient Rejected
hard_bounce409Other

Response Classification

Suppressed or Hard Bounce

Sub-status codes in the 4xx range indicate permanent delivery failures. These emails should not be retried as they represent issues like invalid addresses, blacklists, or permanent rejections.

Soft Bounce

Sub-status codes in the 5xx range indicate temporary delivery failures. These emails may be retried after addressing the underlying issue (server problems, temporary blocks, etc.).

Best Practices

  • Monitor sub-status codes to understand delivery failures
  • Handle soft bounces by implementing retry logic with appropriate delays
  • Remove suppressed and hard bounce emails (4xx sub-status) from your mailing lists
  • Use pagination for large datasets to avoid timeouts
  • Respect rate limits to ensure consistent API access

note

This API is the upgraded version of Get Emails Status with some status values added and removed. The original endpoint is marked deprecated and still usable.


Query Params
string

Recipient email address; separate multiple entries with semicolons.

string

EmailId will be returned after an email was sent with api successfully; separate multiple entries with semicolons, e.g. emailIds=a;b;c

integer

Label ID corresponding to the created label

string

Label Name corresponding to the created label,The length of labelName cannot exceed 254.

string

Stats in the past [days] days ( [days] =1 means today); cannot be more than 3 days

string

Format of start date is yyyy-MM-dd,interval between start and end date cannot be more than 3 days

string

Format of end date is yyyy-MM-dd,interval between start and end date cannot be more than 3 days

string

Multiple apiUsers, separated by semicolons, e.g. apiUserList=a;b;c

string
enum

Email status

Allowed:
string

Multiple subStatus, separated by semicolons, e.g. subStatus=a;b;c

string
Defaults to 0

Start position, [0-], defaults to 0

string
Defaults to 100

Amount, [0-100],defaults to 100

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json