Get access activity events

Returns activity events for the uiData.time specified date range. This API can handle large date range requests. If not specified, the default search time span is 24 hours ago to now.<br/><br/>To filter by time, use a filter value of uiData.time:(utcEpochSeconds-<utcEpochSeconds) or any other valid time range specification, where utcEpochSeconds is replaced by your desired start and end times in unix epoch seconds. To filter by an array field like userGroups, use a filter value of uiData.userGroups.id:(4822,5729). This will filter the results to only those that have a uiData.userGroups.id value of 4822 or 5729. New partial results are returned for each API call. The query is complete when the API returns false for cursors.hasNextPage. The caller is required to pass the same filter parameter across all calls of the same query.<br/><br/>Commonly, the limit parameter provides an upper bound on the number of results returned by the API. That is not the case here. For performance reasons, this API endpoint treats the limit parameter as a suggestion. This endpoint commonly returns substantially more results than the specified limit value. If your client is concerned about a large number of events in the response, the client can first issue a request for 1 hour of data. The 1 hour response size can then be used to calculate the time based paging necessary to maintain a rough amount of response data.<br/><br/>The uiDataOnly option will cause only uiData elements to be returned, filtering out the hookEvents sub-object from the response. This can reduce client JSON processing time and memory utilization if uiData is only needed.<br/><br/>The difference between entryName, zoneName, and siteName vs. entryName2, zoneName2, and siteName2 is that the *Name2 fields can potentially return "Multiple" as the name. This occurs when the entries array indicates multiple unique ids for that resource type. Whereas the entryId, entryName, zoneId, zoneName, siteId, and siteName values will always equal their entries[0] (the first one) equivalent values.<br/><br/>For traceability purposes, it is helpful if your API always provides the option parameter value of searchId:{shortPurpose}-{orgId}-{startTimeMillisecs}-{callNum}. Where {shortPurpose} might be logGather or whatever unique purpose you have in calling the API; {orgId} is your orgId; {startTimeMillisecs} is the time in milliseconds for the first call and remains unchanged for all {callNum} calls; {callNum} starts at 0 and increments for each API call when paging through each returned cursor until complete. An example the first call to this API might have a searchId:logGather-12345-1675964642144-0 for the logGather purpose, 12345 orgId, with the first API call at 2023-02-09T17:44:02.144, and a 0 callNum for the 1st API call. The second API call with the cursor set would be searchId:logGather-12345-1675964642144-1, the 3rd call ...642144-2 and so on. Providing your searchId to an Openpath representative can significantly aid in resolving inqueries.<br/><br/>Please use this API over the slower /orgs/{orgId}/reports/activity API when possible.<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>Endpoint name: getActivityEvents