listSubscribers()

Get detailed information about your subscribers. Choose the type of subscribers list you want to receive:
new - new subscribers in selected period of time,
active - all active subscribers in selected period of time,
total - all subscribers in one list,
userCancel - list of subscribers who canceled the subscription manually,
publisherCancel - list of subscribers who were stopped by publisher,
paymentCancel - list of subscribers who were stopped because of payment failure.

Read more about returned values: All terms in one place: A-Z.

Parameters:

Name Type Description
publisherToken string You can find your publisher token at api-keys page.
offset integer From which offer you want to get results. Helpful in pagination.
limit integer Number of results you want to retrieve. E.g. if you want to display 10 offers per page, and you are on third, just set limit to 10 and offset to 20.
criteria object
-   type string Define what kind of data you want to receive: new, total, userCancel, publisherCancel, paymentCancel
-   offerId string Select subscription offer of which you want to show subscribers e.g. S123456789_FR
-   associateEmail string Set an email address of the associate, to get the list of subscriptions connected to selected associate.
-   dateFrom string From when you want to get subscribers, leave empty if you want to get all of them. Format: Unix Timestamp
-   dateTo string Until when you want to get subscribers, leave empty if you want to get all of them. Format: Unix Timestamp
- required parameter

Request:

    [
    {
    "method": "listSubscribers",
    "params": {
    "publisherToken": "FZ1Q2Q4H18Nx90aaD7rahySGUUkJ1tbeFydpHw1a5vhwUqxL",
    "offset": "0",
    "limit": "50",
    "criteria": {
    "type": "new",
    "offerId": "S123123123_FR",
    "dateFrom": "1352171836",
    "dateTo": "1552171836"
    }
    },
    "jsonrpc": "2.0",
    "id": 1
    }
    ]

Response:

    [
    {
    "result": {
    "items": [
    {
    "cycles": "1",
    "updatedat": "2015-12-16 17:27:28",
    "datefrom": "2015-12-16 17:27:28",
    "dateto": "2015-12-23 17:27:22",
    "customerEmail": "test@cleeng.com",
    "offerId": "S123123123_FR"
    },
    ],
    "totalItemCount": 15
    },
    "id": "1",
    "error": null,
    "jsonrpc": "2.0"
    }
    ]

Remember! you can always check it by yourself using API Console - listSubscribers()

Back to Reporting