--- title: "Get access activity events" method: GET path: "/orgs/{orgId}/reports/activity/events" tags: ["orgs/reports"] --- # Get access activity events `GET /orgs/{orgId}/reports/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.

To filter by time, use a `filter` value of `uiData.time:(utcEpochSeconds-
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.

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.

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.

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.

Please use this API over the slower `/orgs/{orgId}/reports/activity` API when possible.

__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

__Endpoint name__: getActivityEvents ## Path parameters - `orgId` integer, required ## Query parameters - `limit` integer - `cursor` string - `filter` string - `options` string - `customFieldIds` integer[] ## Headers - `x-op-debug` string ## Response `200` Successful - object - `totalCount` integer - `filteredCount` integer - `cursors` object - `nextCursor` integer, nullable - `hasNextPage` boolean - `data` object[] - `uiData` object - `time` number, required - `timeIsoString` string - `userId` number, nullable - `userFirstName` string, nullable - `userMiddleName` string, nullable - `userLastName` string, nullable - `userName` string, nullable - `userEmail` string - `userMobilePhone` string, nullable - `userOrgId` number, nullable - `userOrgName` string, nullable - `userExternalId` string, nullable - `userIdpName` string, nullable - `userGroups` object[] - `id` integer, required - `name` string - `userSites` object[] - `id` integer, required - `name` string - `sourceName` string, required - `category` string, nullable - `subCategory` string, nullable - `credentialSubtype` string - `credentialTypeModelName` string, nullable - `credentialTypeName` string, nullable - `credentialDetail` string, nullable - `cardFields` object, nullable - `rcm` string - `facilityCode` string - `issueLevel` string - `cardId` string - `companyId` string - `companyCode` string - `siteCode` string - `oem` string - `acuId` number, nullable - `acuName` string - `entryId` number, nullable - `entryName` string - `entryName2` string - `zoneId` number, nullable - `zoneName` string, nullable - `zoneName2` string, nullable - `siteId` number, nullable - `siteName` string, nullable - `siteName2` string, nullable - `entries` object[] - `id` integer, required - `name` string - `zone` object - `id` integer, required - `name` string - `site` object - `id` integer, required - `name` string - `lockdownPlanId` number, nullable - `lockdownPlanName` string - `gatewayDevice` object, nullable - `type` string, nullable, required - `uid` string, nullable - `opal` string - `name` string, nullable - `sourceDevice` object, nullable - `type` string, nullable, required - `uid` string, nullable - `opal` string - `name` string, nullable - `deviceDetail` string - `deviceDetailName` string - `deviceTimezone` string, nullable - `readerId` number, nullable - `readerName` string - `readerPortNumber` number, nullable - `portNumber` object - `modelName` 'contactSensor' | 'genericInput' | 'reader' | 'rex' - `raw` integer - `acuId` integer - `expansionBoardNum` integer - `virtualPortNum` integer - `targetType` string, nullable - `targetName` string, nullable - `requestType` string - `requestId` string - `result` string - `resultDescription` string - `deniedReason` string, nullable - `connectionType` string, nullable - `location` string - `userCustomFields` object[] - `id` number, required - `value` string, nullable - `customField` object - `id` number, required - `name` string - `customFieldType` object - `id` number, required - `name` string - `userCustomFieldsData` object - `firstAuthInfos` object[] - `connectionType` string, nullable - `requestType` string - `credentialSubtype` string - `credentialTypeModelName` string, nullable - `credentialDetail` string, nullable - `credentialTypeName` string, nullable - `cardFields` object, nullable - `rcm` string - `facilityCode` string - `issueLevel` string - `cardId` string - `companyId` string - `companyCode` string - `siteCode` string - `oem` string - `readerId` number, nullable - `readerName` string - `userId` number, nullable - `userFirstName` string, nullable - `userMiddleName` string, nullable - `userLastName` string, nullable - `userName` string, nullable - `userEmail` string - `userOrgId` number, nullable - `userOrgName` string, nullable - `userExternalId` string, nullable - `userIdpName` string, nullable - `hookEvent` object - `timestamp` number, required - `event` string, required - `data` object, required - `meta` object - `accessToken` object, nullable - `scopeUpdatedAt` string, date - `siteSpecificAccess` object, nullable - `isSiteSpecific` boolean - `siteIds` integer[], nullable - `siteIdsByScope` object, nullable - `string` integer[], nullable --- [API](https://skmtc.dev/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.dev/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)