VisitorsByWebsiteId: Crisp Visitors
read only REST
- Catalog:
Crisp - Schema:
Crisp - Primary Keys:
session_id - Label: Visitors
Can only retrieve data.
Summary
Visitors present on a website right now; the contents change from one moment to the next.
API Source
- Endpoint:
/website/{website_id}/visitors/list/{page_number}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
website_ |
varchar2 |
The website identifier. Defaults to the website ID of the connection when left out. |
Table Columns
The columns of the table VisitorsByWebsiteId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
active |
char |
itgen_crp_active | filters on the platform, writable | Whether the visitor is actively browsing or not. | |
avatar |
varchar2 |
itgen_crp_avatar | filters on the platform, writable | Avatar of the visitor. | |
email |
varchar2 |
itgen_crp_email | filters on the platform, writable | Email of the visitor. | |
geolocation_ |
varchar2 |
itgen_crp_geolocation_city | filters on the platform, writable, geolocation. |
City name. | |
geolocation_ |
decimal |
itgen_crp_geolocation_coordinates_latitude | filters on the platform, writable, geolocation. |
Latitude coordinate. | |
geolocation_ |
decimal |
itgen_crp_geolocation_coordinates_longitude | filters on the platform, writable, geolocation. |
Longitude coordinate. | |
geolocation_ |
varchar2 |
itgen_crp_geolocation_country | filters on the platform, writable, geolocation. |
Country code. | |
geolocation_ |
varchar2 |
itgen_crp_geolocation_region | filters on the platform, writable, geolocation. |
Region code. | |
inbox_ |
varchar2 |
itgen_crp_inbox_id | filters on the platform, writable | Inbox identifier of the visitor (if any). | |
initiated |
char |
itgen_crp_initiated | filters on the platform, writable | Whether the session is initiated or not. | |
last_ |
varchar2 |
itgen_crp_last_page_title | filters on the platform, writable, last_ |
Title of the last page browsed. | |
last_ |
varchar2 |
itgen_crp_last_page_url | filters on the platform, writable, last_ |
URL of the last page browsed. | |
nickname |
varchar2 |
itgen_crp_nickname | filters on the platform, writable | Nickname of the visitor. | |
session_ |
varchar2 |
itgen_crp_session_id | filters on the platform, writable | Session identifier of the visitor. | |
timezone |
int32 |
itgen_crp_timezone | filters on the platform, writable | Time zone offset of the visitor in minutes relative to UTC, negated (-120 stands for UTC+02:00). | |
useragent |
varchar2 |
itgen_crp_useragent | filters on the platform, writable | User agent as advertised by the browser of the visitor. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: