Home / Statistics / unsubscribes

Statistics ‐ unsubscribes


Description:

Get all unsubscribes

The following errors can occur:
- Token not present in request.
- Token not in the required format.
- Session does not exist.
- Session has expired.
- The user does not exist.
- No database specified.
- Database parameter not in correct format.
- You are not allowed to access this database.

Example:

You should call this function as follows:
- rest/v2/statistics/unsubscribes?token=TOKEN&database=DATABASE_ID
- rest/v2/statistics/unsubscribes?token=TOKEN&database=DATABASE_ID&after=123123123123&records=500
- rest/v2/statistics/unsubscribes?token=TOKEN&database=DATABASE_ID&records=500

                require_once 'Rest.php';

                $username = 'my_username';
                $password = 'my_password';
                $database = '999';

                $rest = new Rest($username, $password, $database);
                $result = $rest->call('statistics/unsubscribes', [
                	'after' => '123123123123',
'records' => '500' ], 'GET'); var_dump($result);

Parameters:

The following parameters this method can/should be called with:

key: after
values: int, UNIX timestamp
what: Retrieve only the bounces generated after given timestamp.

key: records
values: integer, >= 5 & <= 5000, defaults to 100
what: How many bounces to retrieve.

See:

The following items:
- user/login For the TOKEN.
- user/database For the DATABASE_ID