Tut uns leid, dieser Hilfe-Artikel ist zurzeit nicht in Deutsch verfügbar. Wenn Sie möchten, können Sie eine Übersetzung von Google versuchen.
Dieser Hilfeartikel bezieht sich auf eine alte Version von Direct Mail.
This resource supports the GET method
URL Parameters
| Label | Description |
|---|---|
| :document_identifier | The project's document identifier |
GET
Returns an array of all the campaign reports in the project. If the projects contains more than 10 addresses, the results will be paginated. See "Pagination" in the Getting Started guide for more information.
Request Query String Parameters
| Name | Required | Description |
|---|---|---|
| fields | No | A comma-separated list of the keys you want returned for each report. 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 reports in the project |
Response Body
JSON representation of an array of objects. Each object in the array represents a campaign report from the project. Please consult the /projects/:document_identifier/reports/:report_uuid resource for a description of the object keys for each report.
Example
GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports 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 22:55:17 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 1
[
{
"delivery_method": "smtp",
"is_autoresponder": false,
"links": [
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0",
"rel": "self"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/message",
"rel": "message"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients",
"rel": "recipients"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients?status=bounced",
"rel": "bounces"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients?status=unsubscribed",
"rel": "unsubscribes"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients?status=complained",
"rel": "spam-complaints"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients?status=failed",
"rel": "errors"
},
{
"href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/links",
"rel": "links"
}
],
"notes": null,
"number_of_bounced": 0,
"number_of_clicked": 397,
"number_of_clicks": 397,
"number_of_failed": 0,
"number_of_links": 2,
"number_of_opened": 657,
"number_of_opens": 792,
"number_of_recipients": 758,
"number_of_spam_complaints": 0,
"number_of_unsubscribes": 0,
"send_date": "2015-04-23T22:53:48+0000",
"status": "sent",
"title": "This is a test email",
"tracking_enabled": true,
"uuid": "F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0",
"web_message_url": "http://dmanalytics1.com/campaign?d=R2mIj9vGR9WKzA7t4ZYZGQ&t=1",
"web_report_url": null
}
]