Search events

Purpose

This API will provide the search events detail.

Request URL

https://apptics.zoho.com/cx/api/v1/search/event

Or

https://apptics.zoho.com/cx/api/v1/ferret/event

Request body (JSON)

Parameter Data type  Allowed valuesDescription
startDatedatadd-MM-yyyydefault last 7 days
endDate datadd-MM-yyyydefault last 7 days
platformstringiOS/Android/ Windows/tvOS/watchOS/ macOS  default all paltform data will be sent
offsetnumberIntegerspecifies the position of the intial record from which the record will be retrieved  
limitnumber500the number of record required by the user
eventnamestring  
groupnamestring  

Success response

Copied{
    "data": {
        "result": [
            {
               "customproperties": "dummy customprop",
                "janalyticversion": "1.3",
                "appversion": "DDP_00_3",
                "when": 1660288561816,
                "userid": 2141000212651,
                "deviceid": 2141000212649,
                "platform": "iOS",
                "sessionstarttime": 1659510928397,
                "eventgroup": "PRE_GROUP",
                "appreleaseversion": "DDP_11_7",
                "model": 48900,
                "event": "PRE_EVENT",
                "screenname": "DDP - HomeScreen",
                "osversion": "13.600000"
            }
 		],
        "usergivenparams": {
            "startdate": "12-Aug-2022",
            "enddate": "21-Aug-2022",
            "nexturl": "",
            "offset": 0,
            "limit": 0,
          "maxresult": 500
        }
    },
    "status": 200
}

Failure response

Copied{
{
  "order": {
    "status": 0,
    "message": "Sorry! We have run out of stock for today."
  }
}