volver a la Tabla de contenido y API

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.


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


Returns information about each open event for this recipient for this campaign.

Request Query String Parameters

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

Response Body

JSON representation of an array of objects. Each object in the array represents an open event:

Key Value Description
date String The date of the open event, in ISO-8601 format
location Object The geographic location
location.latitude Double Latitude
location.longitude Double Longitude
location.country_code String ISO 3166 country code
location.country_name String Human-readable country name
location.region String Human-readable administrative region
location.city String Human-readable city
user_agent_description String Human-readable description of the user agent that opened the email


GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/opens 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:26:42 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 1

        "date": "2015-04-23T15:54:15-07:00",
        "location": {
            "city": "Sacramento",
            "country_code": "US",
            "country_name": "United States",
            "latitude": 38.531231,
            "longitude": -121.491623,
            "region": "California"
        "user_agent_description": "Apple Mail"

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