Get Visitor Info

Description

You can use this API to get the visitor information. 

Note: In the success response, you'll find a key named "source" under "tracking_details". This value is numeric, with each number representing a specific traffic source:

  1. Direct
  2. Referrals
  3. Search Engine
  4. Campaigns
  5. Google Ads
  6. Social Media
  7. Facebook Ad
  8. Bing Ad

Using this mapping, you can identify how visitors reached your site.

Query Parameters:

  • include - Provide values such as trackinginfo and moreinfo to get particular data.​

OAuth Scope:

conversations.READ

URL

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen name}/conversations/{conversation_id}/visitor

Example:

Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/conversations/430872000002553007/visitor

Sample Response:

Copied{
    "url": "/web/v2/zylker-inc/conversations/430872000002553007/visitor",
    "object": "list",
    "data": {
        "conversation_details": {
            "department_name": "Sales",
            "visit_id": "1637",
            "attender_name": "Patricia",
            "chat_id": "LD_2244863998854132099_1681358420",
            "feedback": 0,
            "add_info": {
                "10": "en-GB,en;q=0.9",
                "1": "http://www.zylker.com/pricing",
                "33": 2047,
                "18": 1
            },
            "participants": [
                "430872000000545001"
            ],
            "uvid": "8ef35562-4ff3-41f1-9e3b-553f8f4be7c7-2",
            "ip": "182.65.170.195",
            "question": "hello",
            "notes": "0",
            "transcript_version": 1,
            "attender_email": "patricia@zylerinc.com",
            "id": "430872000002553007",
            "department_id": "430872000000002013",
            "status": 3,
            "country_code": "IN",
            "uuid": "b3d0c002-648c-4193-a89d-865806810275_a0",
            "app_id": "430872000000002043",
            "attender_id": "430872000000545001",
            "channel": "1",
            "chat_user_id": "$3403221488924853985"
        },
        "more_visitor_details": {
            "location": {
                "local_timezone": "GMT+0530 (India Standard Time)",
                "longitude": "80.278470",
                "state": "TAMIL NADU",
                "country": "INDIA",
                "city": "CHENNAI",
                "ip": "182.65.170.195",
                "latitude": "13.087840"
            },
            "browser": {
                "flashPlayer_version": "0.0.0",
                "scheme": "https",
                "platform": "Linux x86_64",
                "character_encoding": "UTF-8",
                "cookie_support": "true",
                "language": "en-GB,en;q=0.9",
                "browser_type": "Google Chrome",
                "current_page": "http://www.zylker.com/pricing",
                "java_support": "false",
                "script_version": "1.7",
                "browser_version": "86.0.4240.111",
                "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36"
            },
            "system": {
                "color_depth": "24",
                "operating_system": "Linux",
                "screen_resolution": "1848 * 1053"
            },
            "time": {
                "chat_duration": "74141",
                "average_response_time": "0",
                "end_time": "1608281605435",
                "waiting_time": "4385",
                "start_time": "1608281605435",
                "pickup_time": "1608281609820"
            },
            "visitor_info": {
                "phone": "98654343043",
                "email": "james@zylker.com",
                "name": "James"
            },
            "app_data": {
                "business_hours": false,
                "app_name": "zyler-inc",
                "embed_waiting_time": 45,
                "embed_status": "true"
            }
        },
        "tracking_details": {
            "action_message": "Clicked",
            "operating_system": "Linux",
            "source": "1",
            "current_page": "http://www.zylker.com/pricing",
            "visits": "0",
            "triggered_count": "0",
            "chats": "0"
        }
    }
}