Skip to content

User Events

APIs for managing User Events

Operations

Get user events in the account

Request

GET /v3/user-events

This endpoint will get all the changes made by users in the account. This endpoint is only for Admins

Security
API_Key
Query
userIdinteger

filter events by UserId

Example:userId=123
eventTypestring

filter events by event type

Enum:"created""deleted""run-requested""uploaded""edited""overage-enabled""overage-disabled""undeleted"
itemTypestringrequired

filter events by event item type

Enum:"audit""web-journey""mobile-journey""mobile-app-file""folder""subfolder""consent-category""account""email-inbox""grid-saved-report"
itemNamestring

filter events that matches the itemName

itemIdinteger

filter events by itemId

fromTimeStampstring, (date-time)

filter events from this timeStamp

Example:fromTimeStamp=2021-06-01T01:30:00.000-05:00
toTimeStampstring, (date-time)

filter events up to this timeStamp

Example:toTimeStamp=2021-06-01T01:30:00.000-05:00
pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0
pageSizeinteger, [ 100 .. 1000 ]
Default:100
sortBystring
Default:"eventTimeStamp"
Enum:"userId""userName""eventType""itemId""itemName""eventTimeStamp"
sortDescboolean

Controls sorting order

Default:false
GET
/v3/user-events
curl -i -X GET \
  'https://api.observepoint.com/v3/user-events?userId=123&eventType=created&itemType=audit&itemName=string&itemId=0&fromTimeStamp=2021-06-01T01%3A30%3A00.000-05%3A00&toTimeStamp=2021-06-01T01%3A30%3A00.000-05%3A00&page=0&pageSize=100&sortBy=userId&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Retrieve user events in the account

Bodyapplication/json
nextPageboolean

true if there are more pages of data to return

userEventsArray of objects
Response
{
  "nextPage": true,
  "userEvents": [
    { … }
  ]
}