Return cPanel account email tracking statistics

This function retrieves email tracking statistics.

SecurityBasicAuth

Request

query Parameters

deliverytype	string The type of delivery to query. If you do not specify a value, this function returns all types. `remote` `remote-or-faildefer` `local` Enum: "remote" "remote-or-faildefer" "local" Example: deliverytype=remote
endtime	integer <unix_timestamp> Default: "the current time" The end time of the search window. This parameter defaults to the current time. Note You can also call this the `enddate` parameter. Example: endtime=1471552781
nosize	integer Default: 0 Whether to return the `TOTALSIZE` parameter. 1 — Do not return. 0 — Return. Enum: 0 1 Example: nosize=0
nosuccess	integer Default: 0 Whether to return the `SUCCESSCOUNT` parameter. 1 — Do not return. 0 — Return. Enum: 0 1 Example: nosuccess=0
starttime	integer <unix_timestamp> Default: 0 The start time of the search window. Note You can also call this the `startdate` parameter. Example: starttime=1371552781
user	string The cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server's accounts. Example: user=username

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/emailtrack_stats

Request samples

whmapi1 --output=jsonpretty \
  emailtrack_stats

Response samples

application/json

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