Return cPanel account unique email recipients

This function gets the number of unique recipients that a system user sent mail to within a period of time. It groups this data by each of the user's email accounts.

SecurityBasicAuth

Request

query Parameters

end_time required	integer <unix_timestamp> An end time to query. Example: end_time=1550923200
start_time required	integer <unix_timestamp> A start time to query. Example: start_time=1550872800
user required	string The system user's username. Example: user=username

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_unique_recipient_count_per_sender_for_user

Request samples

whmapi1 --output=jsonpretty \
  get_unique_recipient_count_per_sender_for_user \
  user='username' \
  start_time='1550872800' \
  end_time='1550923200'

Response samples

application/json

{"data": {"payload": [{"sender": "username@example.com",
"unique_recipient_count": 51
}
]
},
"metadata": {"command": "get_unique_recipient_count_per_sender_for_user",
"reason": "OK",
"result": 1,
"version": 1
}
}