Light
Dark
System

Better Searching

The Visitor searching endpoint works any type of text and will fuzzy-search through all your Visitors. We also have these special tokens that make the search faster and more accurate

Format

Example

Index used

Any email

john@example.com

Any email provided through uniqueId or identities.

online

online

Filters online visitors only.

-online

-online

Filters offline visitors only.

ip: + the IP

ip:1.1.1.1

Shows visitors with ip 1.1.1.1.

id: + the ID

id:user123

Shows visitors with uniqueId equal to user123.

A four digit number

1234

Shows visitors with the 1234 lookup code.

Any tags

#client

Shows visitors with the #client tag.

integration_id: + integration name + : + integration id

integration_id:acmechat:1234

Shows visitors with integration id acmechat equal to 1234.

Searching for one?

If you are only searching for a single Visitor, make sure you set max_results to 1 to make the search faster. It will return as soon as one of our datacenters finds something, and they tend to respond more quickly when they do find a Visitor in their database.

Previous
Object Types