Blocked
Retrieve blocked items
GETaccount/blocked
Retrieves a list of blocked IP addresses, bots and visitors.
Query String Parameters
presenter | StringDefault Value: Accepted values: Modifies the response data structure
|
Example Request
require_once('gosquared-php-sdk/main.php');
$GS = new GoSquared(array(
'site_token' => 'GSN-106863-S',
'api_key' => 'demo'
));
$result = $GS->account->blocked();Live Responseundefined undefined
Your API Key is not authorised for this endpoint
Please fill in the required fields in the Query Builder
Retrieve blocked bots setting
GETaccount/blocked/bots
Returns whether automatic bot blocking is toggled 'on' for a given project.
Example Request
require_once('gosquared-php-sdk/main.php');
$GS = new GoSquared(array(
'site_token' => 'GSN-106863-S',
'api_key' => 'demo'
));
$result = $GS->account->blocked->bots();Live Responseundefined undefined
Your API Key is not authorised for this endpoint
Please fill in the required fields in the Query Builder
Update blocked bots setting
POSTaccount/blocked/bots
Updates whether the automatic bot blocking feature should be turned on/off for a given project.
Query String Parameters
block | BooleanRequired Whether to block bots or not |
Example Request
The PHP library does not support this function at this timeLive Responseundefined undefined
Your API Key is not authorised for this endpoint
Example Request
require_once('gosquared-php-sdk/main.php');
$GS = new GoSquared(array(
'site_token' => 'GSN-106863-S',
'api_key' => 'demo'
));
$result = $GS->account->blocked->ips();Live Responseundefined undefined
Your API Key is not authorised for this endpoint
Please fill in the required fields in the Query Builder
Update blocked IPs
POSTaccount/blocked/ips
Updates the list of IP addresses to be blocked for a given project.
Query String Parameters
ip | StringRequired IP address(es) with multiple entries separated by a comma (,) |
Example Request
The PHP library does not support this function at this timeLive Responseundefined undefined
Your API Key is not authorised for this endpoint
Unblock IP addresses
DELaccount/blocked/ips
Removes one or more IP addresses from the blocked list
Query String Parameters
ip | StringRequired IP address(es) with multiple entries separated by a comma (,) |
Example Request
The PHP library does not support this function at this timeLive Responseundefined undefined
Your API Key is not authorised for this endpoint
Retrieve blocked visitors
GETaccount/blocked/visitors
Retrieves a list of visitor IDs that have been blocked for a given project. Most commonly a visitor will have been blocked from hitting the 'Ignore' button from within the Visitor widget on your Now dashboard.
Query String Parameters
presenter | StringDefault Value: Accepted values: Modifies the response data structure
|
Example Request
require_once('gosquared-php-sdk/main.php');
$GS = new GoSquared(array(
'site_token' => 'GSN-106863-S',
'api_key' => 'demo'
));
$result = $GS->account->blocked->visitors();Live Responseundefined undefined
Your API Key is not authorised for this endpoint
Please fill in the required fields in the Query Builder
Update blocked visitors
POSTaccount/blocked/visitors/{visitorID}
Updates the list of blocked visitors for a given project.
Path Parameters
visitorID | StringRequired The ID of the visitor |
Example Request
The PHP library does not support this function at this timeLive Responseundefined undefined
Your API Key is not authorised for this endpoint
Unblock visitors
DELaccount/blocked/visitors/{visitorID}
Removes a visitor from the blocked list for a given project.
Path Parameters
visitorID | StringRequired The ID of the visitor |
Example Request
The PHP library does not support this function at this timeLive Responseundefined undefined
Your API Key is not authorised for this endpoint