Get the Events List

Description

You can use this API to fetch the events list of the visitors for the given time in Milliseconds.

Note: For the API to work, you should enable the Actions performed by visitors on your website option in the Settings > Portal Settings > API Permissions. 

HTTP Method - GET

Query Parameters

  • limit : The number of visitors you would like to fetch at a time by hitting the API once. By default the limit is set to 200, if you fail to set the limit then the default limit will be set to fetch. You can use the limit param to set the limit below the default limit and not above, ie., you can set the limit within 200, but cannot set above 200. 
  • prev_key : To fetch the data available before the specified time in Milliseconds. When you use the API for the first time, you should mention the Start time, after that you should use the last response prev_key of the previous API to fetch the prior data. 

(or)

  • next_key : To fetch the data after the given time in Milliseconds. When you use the API for the first time, you should mention the start time, after that you should use the last response next_key of the previous API to fetch the data thereafter. 

Note: You can either use prev_key or next_key to fetch the data at a time, you cannot use both the keys together. 

URL:

Copiedhttps://salesiq.zoho.com/api/v3/{screenname}/visitorevents/

Example:

Copiedhttps://salesiq.zoho.com/api/v3/zylker/visitorevents?limit=4&next_key=1548845978127

Sample Response:

Copied{
  "data": [
    {
      "uuid": "1748fe6b-8b66-4f5e-9ff0-5a0fd0a9f1_7",
      "uvid": "1dbf0356-7e95-4feb-b6ca-3f75005e524",
      "url": "https://zylker/home.html",
      "event": "PAGE_ACCESS",
      "time": "1549009433445",
      "time_spent": "714936",
      "visit_id": "5895806520411901444"
    },
    {
      "uuid": "cb33582e-c9eb-44d2-95c7-e056090012c8_1",
      "uvid": "5ef6d1fc-bfc1-44ea-bab8-80de08116cd7",
      "url": "http://zylker/about-us.html",
      "event": "PAGE_ACCESS",
      "time": "1549014285205",
      "visit_id": "-2573473626758164723"
    }
  ],
  "next_key": "1549014590243",
  "prev_key": "1548845978127",
  "url": "/api/v3/visitorevents",
  "object": "list"
}