GET reports/master-events/{id}

Overview

This method retrieves a previsously requested report. Reports are available for 7 days from the original request date.

Resource URI

 https://api.yesmail.com/v2/reports/master-events/{id}

Call Description

The GET /v2/reports/master-events/{id} call returns the results of a message based event report.

HTTP Return Codes

 

Code

Description

200 OK

Returned when the report ID exists.

401 Unauthorized

The request requires user authentication.  Invalid Api-User and/or Api-Key header value.

404 Not Found The Report ID cannot be found. May not exist for the given api-user or may be deleted.

Response

Request for all events, but over a short time period.

{
    "counts": {
        "sent": 6,
        "opens": 2,
        "clicks": 1,
        "unsubscribes": 0,
        "bounces": 0,
        "uniqueClicks": false,
        "uniqueOpens": true
    },
    "filters": {
        "masterId": "1121347",
        "opens": true,
        "clicks": true,
        "unsubscribes": true,
        "bounces": true,
        "period": "2014-09-03T16:45:00.000-07:00/2014-09-05T16:45:00.000-07:00"
    },
    "clicks": [
        {
            "id": "somebody@yahoo.com",
            "time": "2014-09-05T17:25:10.000Z",
            "uri": "http://www.yesmail.com/il/chicago/k2-clients?rid=p17481-204&utm_medium=email&utm_source=rmkt"
        }
    ],
    "opens": [
        {
            "id": "valued_customer@gmail.com",
            "time": "2014-09-05T01:28:21.000Z"
        },
        {
            "id": "robot_overlord@gmail.com",
            "time": "2014-09-05T22:17:09.000Z"
        }
    ],
    "unsubscribes": [],
    "bounces": []
}

Response

Just KPIs for the last seven days

{
    "counts": {
        "sent": 107834,
        "opens": 10275,
        "clicks": 801,
        "unsubscribes": 294,
        "bounces": 4949,
        "uniqueClicks": false,
        "uniqueOpens": true
    },
    "filters": {
        "masterId": "1139804",
        "opens": false,
        "clicks": false,
        "unsubscribes": false,
        "bounces": false,
        "period": "2014-10-16T06:52:38.621-07:00/2014-10-23T06:52:38.621-07:00"
    }
}