Get recipient detail
GET /statistics/recipient/{recipientEmail}
Parameters:
| Name | Description | Type | Mandatory |
|---|---|---|---|
| recipientEmail | Recipient email | String | Yes |
Response:
| Name | Description | Type |
|---|---|---|
| requested | Number of emails sent to this recipient | Int |
| delivered | Number of emails delivered to this recipient | Int |
| open | Number of emails opened by this recipient | Int |
| click | Number of emails clicked by this recipient | Int |
| unsubscribed | Number of clicks on the unsubscribe link | Int |
| opener | Number of unique open | Int |
| clicker | Number of unique click | Int |
Programming language:
Response exemple:
{
"requested": 98,
"delivered": 94,
"open": 52,
"click": 12,
"unsubscribed": 0,
"opener": 47,
"clicker": 11
}
Code example:
curl -X GET -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/statistics/recipient/email@example.com
require 'vendor/autoload.php';
$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');
try {
$result = $tipimail->getStatisticsService()->getRecipientDetail('to@example.com');
var_dump($result);
}
catch(Tipimail\Exceptions\TipimailException $e) {
echo 'Exception received :', $e->getMessage(), "\n";
}
...
public class Example {
public static void main(String[] args) {
Tipimail tipimail = new Tipimail("YOUR_SMTP_USERNAME", "YOUR_API_KEY");
try {
tatisticsRecipientDetails recipientDetails;
recipientDetails = tipimail.getStatisticsService().getRecipientDetail("to@example.com");
}
catch (TipimailException e) {
}
}
}