Blocked

Retrieve blocked items

GETaccount/blocked

Retrieves a list of blocked IP addresses, bots and visitors.

Query String Parameters

presenter

StringDefault Value: plain

Accepted values: plain, tags, indexedTags

Modifies the response data structure

  • plain: A list of visitor IDs
  • tags: A list of objects including the visitor ID and the tag
  • indexedTags: A key:value object of visitorID:tag

Definition

GET https://api.gosquared.com/account/v1/blocked

Example Request

curl "https://api.gosquared.com/account/v1/blocked?api_key=demo&site_token=GSN-106863-S"

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.

Definition

GET https://api.gosquared.com/account/v1/blocked/bots

Example Request

curl "https://api.gosquared.com/account/v1/blocked/bots?api_key=demo&site_token=GSN-106863-S"

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

Definition

POST https://api.gosquared.com/account/v1/blocked/bots

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/blocked/bots?api_key=demo&site_token=GSN-106863-S"

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Retrieve blocked IPs

GETaccount/blocked/ips

Retrieves a list of blocked IP addresses.

Definition

GET https://api.gosquared.com/account/v1/blocked/ips

Example Request

curl "https://api.gosquared.com/account/v1/blocked/ips?api_key=demo&site_token=GSN-106863-S"

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 (,)

Definition

POST https://api.gosquared.com/account/v1/blocked/ips

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/blocked/ips?api_key=demo&site_token=GSN-106863-S"

Live 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 (,)

Definition

DEL https://api.gosquared.com/account/v1/blocked/ips

Example Request

curl -X DEL -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/blocked/ips?api_key=demo&site_token=GSN-106863-S"

Live 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: plain

Accepted values: plain, tags, indexedTags

Modifies the response data structure

  • plain: A list of visitor IDs
  • tags: A list of objects including the visitor ID and the tag
  • indexedTags: A key:value object of visitorID:tag

Definition

GET https://api.gosquared.com/account/v1/blocked/visitors

Example Request

curl "https://api.gosquared.com/account/v1/blocked/visitors?api_key=demo&site_token=GSN-106863-S"

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

Definition

POST https://api.gosquared.com/account/v1/blocked/visitors/{visitorID}

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/blocked/visitors/{visitorID}?api_key=demo&site_token=GSN-106863-S"

Live 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

Definition

DEL https://api.gosquared.com/account/v1/blocked/visitors/{visitorID}

Example Request

curl -X DEL -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/blocked/visitors/{visitorID}?api_key=demo&site_token=GSN-106863-S"

Live Responseundefined undefined

Your API Key is not authorised for this endpoint