Retrieve all clicks
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.
- The email parameter is required.
- The email parameter is invalid.
- The selected subscriber does not exist.
- An id/list of ids are required.
- The since parameter is required.
- The since parameter can not be empty.
- You requested more clicks then there are in the database.
You should call this function as followed:
- rest/v2/click/all?token=TOKEN&database=DATABASE_ID&since=2012-01-01&records=0&offset=1000
require_once 'Rest.php';
$username = 'my_username';
$password = 'my_password';
$database = '999';
$rest = new Rest($username, $password, $database);
$result = $rest->call('click/all', [
'since' => '2012-01-01',
'records' => '0',
'offset' => '1000'
], 'GET');
var_dump($result);
The following parameters this method can/should be called with:
key: since
values: string, String, any value that can be converted by php/strtotime, required
what: date from which the reads must be retrieved
key: offset
values: integer, not required
what: start from record number
key: records
values: integer, not required
what: How many subscribers do you want back (max 5000)
The following items:
- user/login For the TOKEN.
- user/database For the DATABASE_ID