Get message detail
GET /statistics/message/{messageId}
Parameters:
| Name | Description | Type | Mandatory |
|---|---|---|---|
| messageId | Message Id | String | Yes |
Response:
| Name | Description | Type | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| messageId | Message Id | String | ||||||||||||||||||
| msg |
|
Struct | ||||||||||||||||||
| open | Number of open | Int | ||||||||||||||||||
| click | Number of click | Int | ||||||||||||||||||
| openDetails |
|
Array | ||||||||||||||||||
| clickDetails |
|
Array |
Programming language:
Response exemple:
{
"messageId": "56546ht54h6t468787665408",
"msg": {
"receivedAt": 1443435712,
"from": "from@example.com",
"email": "email@example.com",
"subject": "test",
"size": 57
},
"open": 2,
"click": 0,
"openDetails": [
{
"userAgent": {
"ip": "00.00.000.000",
"latitude": 47.6801,
"longitude": -122.120605,
"country": "United States",
"region": "WA",
"city": "Redmond",
"postcode": "98052",
"operatingSystem": "LINUX",
"language": "fr-fr,fr,en",
"browser": "CHROME 45.0.2454.85",
"webmail": "Unknown",
"deviceType": "Computer"
},
"recipient": {
"address": "recipient1@example.com"
}
},
{
"userAgent": {
"ip": "00.00.000.000",
"latitude": 47.6801,
"longitude": -122.120605,
"country": "United States",
"region": "WA",
"city": "Redmond",
"postcode": "98052",
"operatingSystem": "LINUX",
"language": "fr-fr,fr,en",
"browser": "CHROME 45.0.2454.85",
"webmail": "Unknown",
"deviceType": "Computer"
},
"recipient": {
"address": "recipient2@example.com"
}
}
],
"clickDetails": []
}
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/message/560914c09932b9e3c31c8c08
node
require 'vendor/autoload.php';
$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');
try {
$result = $tipimail->getStatisticsService()->getMessageDetail('646r54g6r4gr6g46g46546d4');
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 {
tatisticsMessageDetails messageDetails;
messageDetails = tipimail.getStatisticsService().getMessageDetail("646r54g6r4gr6g46g46546d4");
}
catch (TipimailException e) {
}
}
}