latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail

cPanel Account Mail Management

Return cPanel account email tracking statistics

This function retrieves email tracking statistics.

get/emailtrack_stats

Query parameters

deliverytype'remote' | 'remote-or-faildefer' | 'local'

Example:remote

The type of delivery to query. If you do not specify a value, this function returns all types.

remote
remote-or-faildefer
local

enddateinteger

Example:1471552781

The end date of the search window. This parameter defaults to the current time.

Note

This parameter is an alias for endtime and is provided for backwards compatibility.

endtimeinteger

Example:1471552781

The end time of the search window. This parameter defaults to the current time.

Note

You can also call this the enddate parameter.

nosize0 | 1

Whether to return the TOTALSIZE parameter.

1 — Do not return.
0 — Return.

nosuccess0 | 1

Whether to return the SUCCESSCOUNT parameter.

1 — Do not return.
0 — Return.

startdateinteger

Example:1371552781

The start date of the search window.

Note

This parameter is an alias for starttime and is provided for backwards compatibility.

starttimeinteger

Example:1371552781

The start time of the search window.

Note

You can also call this the startdate parameter.

userstring

Example:username

The cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server's accounts.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "records": [
      {
        "SENDCOUNT": 14,
        "SUCCESSCOUNT": 14,
        "TOTALSIZE": 27444
      }
    ]
  },
  "metadata": {
    "command": "emailtrack_stats",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}