Help Documentation 〉API 〉
/projects/:document_identifier/reports/:report_uuid/recipients/:recipient_uuid/clicks
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 each click event for this recipient for this campaign.
GET Request Query String Parameters
| Name |
Required |
Description |
| fields |
No |
A comma-separated list of the keys you want returned for each click event. 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 |
| Name |
Description |
| X-Total-Count |
The total number of clicks |
GET Response Body
JSON representation of an array of objects. Each object in the array represents an click event:
| Key |
Value |
Description |
| date |
String |
The date of the open event, in ISO-8601 format |
| url |
String |
The URL that was clicked |
GET Example
GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E5A667C9-58AE-4B86-AB6D-DA0D33D7CC00/clicks 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:33:17 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 1
[
{
"date": "2015-04-23T15:54:28-07:00",
"url": "http://apple.com"
}
]
