Searching users
You can use the REST API to search for visitors in your project using the POST
call.
Searching for visitors
To search for visitors in your project using the REST API, you need to create a filters
array.
Filters format
Objects in the filters
array must contain a name
and value
parameter. An operator
parameter is optional (default value is is
):
POST https://api.eu.smartlook.cloud/api/v1/visitors/search
{
"filters": [
{
"name": "uid",
"value": "some-uid"
}
]
}
You can also use an operator:
POST https://api.eu.smartlook.cloud/api/v1/visitors/search
{
"filters": [
{
"name": "recording_date",
"operator": "is",
"value": "2023-05-18"
}
]
}
The following table contains all possible combinations of operators and values for each possible filter.
Filter name | Description | Allowed operator | Allowed value | Notes |
---|---|---|---|---|
uid | Unique user ID | is | <string> , [<string>,<string>,...] | value can be an array |
recording_date | Date of the session recording | before , after , is , in_range | <string> ,[<string>,<string>,...] [<string>,<string>] | Must be a date. When using in_range , must be an array with ["from date", "to date"] |
For more information, see the Search visitors in the API reference.
Updated 9 days ago