Get subscribers count

Get counts information on a subscribers list (numbers of subscribers, unsubscribed users...)

Endpoint URI

GET https://services.ownpage.fr/v1/newsletters/lists/LIST_ID/subscribers/count

Endpoint parameters

LIST_ID : the email list you want to read

Headers

X-Ownpage-Client-Token : a valid token

Response (JSON)

The response is an object containing the following :

subscribed: Number of subscribed users in the list
unsubscribed: Number of unsubscribed users in the list
cause: Number of unsubscribed users, sorted by cause
- HARD_BOUNCE: Unsubscribed users due to a "hard bounce" (i.e: invalid address)
- MULTIPLE_BOUNCES: Unsubscribed users due to multiple delivery problems (3 bounces in a row)
- PUBLISHER: Unsubscribed users due a decision of the publisher (via API or the Dashboard)
- READER: Unsubscribed users due to their own decision (i.e: they clicked on the unsubscribe link)

Example

We get the counts of the list with id #123

curl -H "X-Ownpage-Client-Token:TOKEN" https://services.ownpage.fr/v1/newsletters/lists/123/subscribers/count

Response example:

{
    "subscribed" : 12034,
    "unsubscribed" : 83,
    "cause": {
        "HARD_BOUNCE": 30,
        "MULTIPLE_BOUNCES": 12,
        "PUBLISHER": 1,
        "READER": 52
    }
}