GET subscribers/{id}/emails

Overview

 

GET /v2/subscribers/{id}/emails returns the message ID and template ID for each email sent to the specified subscriber, as well as a summary of email statistics for that subscriber.

 

In order to limit payload size, the maximum number of emails that can be returned in a single call is 100. The full list of emails can be obtained via a series of GET v2/subscribers/{id}/emails calls using appropriate values of the LIMIT and OFFSET parameters.

Resource URI

 

https://api.yesmail.com/v2/subscribers/{id}/emails

Call Description

 

The GET /v2/subscribers/{id}/emails call returns the message ID and template ID for each email sent to the specified subscriber, as well as a summary of email statistics for that subscriber.

Parameters

 

Parameter

Requirement

Description

limit

Optional

The maximum number of subscribers to be provided within the request.  Valid values are integers 0-100.  The default is 25.

offset

Optional

The sequence number of the first subscriber to be provided within the request.  Valid values are 0-any positive integer.  The default is 0.  In conjunction with limit, this can be used to “page through” the full result set of emails.

 

HTTP Return Codes

 

Code

Description

200 OK

The request has succeeded.

400 Bad Request

The request could not be understood by the server due to malformed syntax.  For example, incorrect syntax of parameters, invalid parameter values.

401 Unauthorized

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

Response Payload: 
{
    "offset": 50,
    "limit": 25,
    "count": 7,
    "total": 57,
    "countTotalSent": 1234,
    "countTotalOpens": 750,
    "countUniqueOpens": 450,
    "countTotalClicks": 300,
    "countUniqueClicks": 180, 
    "countTotalDelivered": 1115,
    "countTotalBounced": 119
    "messages": [
        {
            "id": "2652602353291",
            "templateId": "653965203"
        },
        {
            "id": "2672355069241",
            "templateId": "654424409"
        },
        …more emails…
    ]
}