Return all cPanel account unique email recipients

This function gets a count of the email addresses that each system account sent mail to within a specific period of time. It groups the data by each system user for all the system's users.

SecurityBasicAuth
Request
query Parameters
end_time
required
integer <unix_timestamp>

An end time to query.

Example: end_time=1551192100
start_time
required
integer <unix_timestamp>

A start time to query.

Example: start_time=1550702383
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/get_unique_sender_recipient_count_per_user
Request samples
whmapi1 --output=jsonpretty \
  get_unique_sender_recipient_count_per_user \
  start_time='1550702383' \
  end_time='1551192100'
Response samples
application/json
{
  • "data": {
    • "payload": [
      • {
        • "unique_sender_recipient_count": 120,
        • "user": "username"
        }
      ]
    },
  • "metadata": {
    • "command": "get_unique_sender_recipient_count_per_user",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}