Documentación de ayuda 〉API 〉

/projects/:document_identifier/reports/:report_uuid/links

Lo sentimos, este artículo de ayuda aún no está traducido al español. Si lo desea, puede probar una traducción automática de Google.

Este artículo de ayuda es para una versión anterior de Direct Mail.

This resource supports the GET method.

URL Parameters

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

GET

Returns an array of all the links in this campaign's message.

Request Query String Parameters

Name Required Description
fields No A comma-separated list of the keys you want returned for each 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 Headers

Name Description
X-Total-Count The total number of links

Response Body

JSON representation of an array of objects. Each object in the array represents a links. Please consult the /projects/:document_identifier/reports/:report_uuid/links/:link_uuid resource for a description of the object keys for each link.

Example

GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links 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:01:25 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 2

[
    {
        "links": [
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links/0022F304-3CBA-4D31-A4F8-1875A3F4F1EA",
                "rel": "self"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links/0022F304-3CBA-4D31-A4F8-1875A3F4F1EA/clicks",
                "rel": "clicks"
            }
        ],
        "number_of_clicks": 192,
        "number_of_unique_clicks": 192,
        "title": "http://directmailmac.com",
        "url": "http://directmailmac.com",
        "uuid": "0022F304-3CBA-4D31-A4F8-1875A3F4F1EA"
    },
    {
        "links": [
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links/4C5CF734-C061-4174-BED2-504B26193833",
                "rel": "self"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links/4C5CF734-C061-4174-BED2-504B26193833/clicks",
                "rel": "clicks"
            }
        ],
        "number_of_clicks": 205,
        "number_of_unique_clicks": 205,
        "title": "links",
        "url": "http://www.example.com",
        "uuid": "4C5CF734-C061-4174-BED2-504B26193833"
    }
]

¿Le ha resultado útil este artículo? | No