Tagged Visitors

Retrieve tagged visitors

GETaccount/taggedVisitors

Retrieves the list of tagged visitors.

Query String Parameters

presenter

StringDefault Value: plain

Accepted values: plain, indexed

Modifies the response data structure

  • plain: A list of visitors objects
  • indexed: A key:value object of visitorID:tag

limit

StringDefault Value: 0,100

The maximum number of results e.g. 10 to return with an optional offset e.g. 5,10

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

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

Example Request

curl "https://api.gosquared.com/account/v1/taggedVisitors?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

Add a tagged visitor

POSTaccount/taggedVisitors/{visitorID}

Adds a tag to an identified visitor.

Path Parameters

visitorID

StringRequired

The ID of the visitor

POST Body

tag

String or number

The tag to attach to the visitor.

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

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

Example Request

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

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Remove a tagged visitor

DELaccount/taggedVisitors/{visitorID}

Removes the given visitorID's tag.

Path Parameters

visitorID

StringRequired

The ID of the visitor

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

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

Example Request

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

Live Responseundefined undefined

Your API Key is not authorised for this endpoint