Help Documentation 〉API 〉
/projects/:document_identifier/reports/:report_uuid/recipients/:recipient_uuid
This resource supports the GET method.
URL Parameters
| Label |
Description |
| :document_identifier |
The project's document identifier |
| :report_uuid |
The UUID of the report |
| :recipient_uuid |
The UUID of the recipient |
GET
Returns information about the recipient.
GET Request Query String Parameters
| Name |
Required |
Description |
| fields |
No |
A comma-separated list of the keys you want returned for the recipient. Default is to return all keys. |
GET Response Status Codes
| Code |
Description |
| 503 Service Unavailable |
Server is undergoing maintenance and is unavailable |
| 429 Rate Limited |
Rate limiting in effect, try again later |
| 404 Not Found |
The resource could not be found or your API key has not been granted access to it |
| 403 Forbidden |
Direct Mail account is disabled |
| 401 Unauthorized |
API key, secret, or authentication method is incorrect |
| 200 OK |
Success |
GET Response Body
A JSON object representing the address.
| Key |
Value |
Description |
| uuid |
String |
The UUID of the recipient |
| email |
String |
The email address of the recipient |
| sent |
Boolean |
True if the campaign has been sent to this recipient |
| failed |
Boolean |
True if the campaign failed to send to this recipient |
| failure_description |
String |
Human-readable description of why the campaign failed to send to this recipient |
| bounced_hard |
Boolean |
True if this recipient hard bounced |
| bounced_soft |
Boolean |
True if this recipient soft bounced |
| bounce_reason |
String |
The reason this recipient bounced. One of unknown, unknown-user, mailbox-full, invalid-domain, spam, too-large. |
| unsubscribed |
Boolean |
True if this recipient unsubscribed |
| unsubscribe_date |
String |
The date this recipient unsubscribed, in ISO-8601 format |
| reported_spam_complaint |
Boolean |
True if this recipient reported this campaign as spam |
| spam_complaint_date |
String |
The date this recipient reported the complaint, in ISO-8601 format |
| anonymized |
Boolean |
True if the personal information for this recipient was deleted/anonymized |
| number_of_opens |
Integer |
The number of times this recipient opened the campaign. null if the campaign was sent with tracking turned off. |
| number_of_clicks |
Integer |
The number of times this recipient clicked this campaign. null if the campaign was sent with tracking turned off. |
| send_date |
String |
The date the campaign was sent to this recipient, in ISO-8601 format |
| links |
Array of Object |
URLs for the recipient (rel:self), the archived address (rel:archived-address), the live address (rel:live-address), this recipient's opens (rel:opens), and this recipient's clicks (rel:clicks). URLs for opens and clicks will not be included in the array of links if the campaign was sent with tracking turned off. |
GET Example
GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A HTTP/1.1
Authorization: Basic QzFENDREMjEtNTA4MC00NTM3LUFFOD
Accept: application/json; charset=utf-8
Host: secure.directmailmac.com
HTTP/1.1 200 OK
Date: Thu, 23 Apr 2015 23:25:48 GMT
Content-Type: application/json; charset=utf-8
{
"bounce_reason": null,
"bounced_hard": false,
"bounced_soft": false,
"email": "user101@example.com",
"failed": false,
"failure_description": null,
"links": [
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A",
"rel": "self"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/archived-address",
"rel": "archived-address"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/live-address",
"rel": "live-address"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/opens",
"rel": "opens"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/clicks",
"rel": "clicks"
}
],
"number_of_clicks": 0,
"number_of_opens": 1,
"reported_spam_complaint": false,
"send_date": "2015-04-23T22:53:48+0000",
"sent": true,
"spam_complaint_date": null,
"unsubscribe_date": null,
"unsubscribed": false,
"uuid": "E336DC4B-43BA-45B6-9290-14568D8A431A"
}
