Return all cPanel accounts email tracking statistics

This function retrieves email tracking statistics for each user.

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. Example: endtime=1471552781
sender	string <email> The sender's email address. If you do not specify a value, this function returns entries for mail from all senders. Example: sender=username@example.com
starttime	integer <unix_timestamp> Default: 0 The start time of the search window. Example: starttime=1371552781

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/emailtrack_user_stats

Request samples

whmapi1 --output=jsonpretty \
  emailtrack_user_stats

Response samples

application/json

{"data": {"records": [{"DEFERCOUNT": 0,
"DEFERFAILCOUNT": 0,
"DOMAIN": "example.com",
"FAILCOUNT": 0,
"OWNER": "root",
"PRIMARY_DOMAIN": "example.com",
"REACHED_MAXDEFERFAIL": 1,
"REACHED_MAXEMAILS": 1,
"SENDCOUNT": 14,
"SUCCESSCOUNT": 14,
"TOTALSIZE": 27444,
"USER": "example"
}
]
},
"metadata": {"command": "emailtrack_user_stats",
"reason": "OK",
"result": 1,
"version": 1
}
}