Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (partially deprecated)
      • Statistic
      • Group (deprecated)
      • Call meeting
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • Get visitors
  • Filters
  • Get a visitor details
  • Fields

Was this helpful?

  1. Technologies
  2. REST API (partially deprecated)

Visitor (deprecated)

PreviousTransaction (deprecated)NextWebhooks

Last updated 1 year ago

Was this helpful?

This resource is deprecated. You should consider using our GraphQL API with the Visitor object.

Get visitors

GET /visitor

See below to discover used fields and see to discover some output examples.

Filters

Filter
Description
Use

unique_id

Unique identifier

?filters[unique_id]=123

external_id

External identifier

?filters[external_id]=123

website_id

Website identifier

?filters[website_id]=123

Get a visitor details

GET /visitor/560

See to discover some output examples.

Fields

Field
Description
Values

id

Visitor identifier

Integer

unique_id

Visitor unique identifier

String

external_id

Your id if provided

String

lastname

Last name

String

firstname

First name

String

address

Address

String

city

City

String

zip

Zip code

String

country

Country

String

phone

Phone number

String

email

Email

String

browser

Browser used by visitor

String

website_id

List of website identifiers

List of integers

created_at

Visitor creation date

Date YYYY-MM-DD HH:MM:SS

reading section
reading section