Skip to content

Get Visitor Workspace

GET
/visitors/streams

The tracking workspace: its streams and their public write keys.

The write keys are what the browser snippet sends with, so this is the endpoint a rebuilt install flow reads to render the snippet.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The tracking workspace’s streams.

object
streams
Array<object>

One tracking stream and the public keys the snippet sends with.

object
id
Any of:
string
name
Any of:
string
publicKeys

Public write keys. Named in the app’s camelCase rather than re-cased here - the snippet reads this value verbatim, and renaming it would be a silent breakage in a copy-paste flow.

Array<string>
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string