Visitors

Retrieve online visitors

GETnow/visitors

Retrieves a list of online visitors with information relevant to them and the pages that they are visiting.

Query String Parameters

limit

StringDefault Value: 0,10

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

visitorsMode

StringDefault Value: all

Accepted values: all, tagged, returning

The type of visitors to retrieve

from

String

The start date-time for the query

to

String

The end date-time for the query

dateFormat

String

The format that any date parameters will be returned in. This takes any value permitted by Moment.

Definition

GET https://api.gosquared.com/now/v3/visitors

Example Request

curl "https://api.gosquared.com/now/v3/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

Retrieve a visitor

GETnow/visitors/{visitorID}

Retrieves information for a specific visitor

Path Parameters

visitorID

StringRequired

The ID of the visitor

Query String Parameters

limit

StringDefault Value: 0,10

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

visitorsMode

StringDefault Value: all

Accepted values: all, tagged, returning

The type of visitors to retrieve

presenter

StringDefault Value: events

Accepted values: plain, events, pageEvents

Modifies the response data structure

Definition

GET https://api.gosquared.com/now/v3/visitors/{visitorID}

Example Request

curl "https://api.gosquared.com/now/v3/visitors/{visitorID}?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