Report for a Single Transactional Message
GET https://api.expresspigeon.com/messages/{id}
Returns a report with properties of a sent message, such as 'delivered' or 'bounced', 'opened', 'clicked' etc.
Request parameters
id |
Yes |
Id of sent message |
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/messages/1'
|
1
2
3
4
5
6
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toMap;
String response = Http.get("https://api.expresspigeon.com/messages/1")
.header("X-auth-key", AUTH_KEY).text();
Map<String, Object> result = toMap(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/messages/1', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
report = ExpressPigeon::API.messages.report(1)
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.messages.report(1)
|
Please, note that the 1
in the example is an ID of the message generated when it was sent.
Transactional message IDs should be treated as opaque unique strings, and not necessarily numbers.
Example Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| {
"id": 1,
"email": "john@example.net",
"in_transit": false,
"delivered": true,
"bounced": false,
"opened": true,
"clicked": true,
"urls": [
"http://example.net/buy_a_burger"
],
"spam": false,
"created_at": "2013-03-15T11:20:21.770+0000",
"updated_at": "2013-03-16T11:22:23.210+0000"
}
|
The report above is self-explanatory.