return to Table of Contents, API


This resource supports the GET method.

URL Parameters

Label Description
:document_identifier The project's document identifier
:report_uuid The UUID of the report
:link_uuid The UUID of the link


Returns information about the link.

Request Query String Parameters

Name Required Description
fields No A comma-separated list of the keys you want returned for the link. Default is to return all keys.

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

Response Body

A JSON object representing the link.

Key Value Description
uuid String The UUID of the link
title String The title of the link
url String The URL of the link
number_of_unique_clicks Integer The number of recipients that clicked on this link at least once
number_of_clicks Integer The total number of clicks on this link
links Array of Object URLs for the link (rel:self) and this link's click events (rel:clicks)


GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links/0022F304-3CBA-4D31-A4F8-1875A3F4F1EA HTTP/1.1
Authorization: Basic QzFENDREMjEtNTA4MC00NTM3LUFFOD
Accept: application/json; charset=utf-8

HTTP/1.1 200 OK
Date: Thu, 23 Apr 2015 23:36:34 GMT
Content-Type: application/json; charset=utf-8

    "links": [
            "href": "",
            "rel": "self"
            "href": "",
            "rel": "clicks"
    "number_of_clicks": 192,
    "number_of_unique_clicks": 192,
    "title": "visit our website",
    "url": "",
    "uuid": "0022F304-3CBA-4D31-A4F8-1875A3F4F1EA"

Did you find this article helpful? Yes | No