Retrieve user activity

  • Updated on Jul 16, 2024
  • 2 minute(s) read
Prev Next
Get
/SearchUserActivity

Allows you to search for user activity.

Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)

A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).

pageSize
integer (int32)

Indicates how many results you want per page. if not supplied, a default value of 100 is used.

sort
string

The value you want to sort by. If not supplied, a default value of "SignIn DESC" will be assumed. You can append " DESC" after the sort value to sort descending. For example, "SignIn DESC" would sort by sign-in time in descending order. Possible values:

  • RequestTime
  • LastName
  • UserName
  • Organization
userId
integer (int32)

An optional parameter used to filter for activity for a particular user

userExternalId
string

An optional parameter used to filter for activity for a particular user using an external identifier

activityAfter
string

An optional parameter used to filter for sign-ins that occured after a specified date

activityBefore
string

An optional parameter used to filter for sign-ins that occured before a specified date

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

TotalCount
integer (int32)

The total number of results that match the search conditions, not all of which may be in the current result set.

Example1
TotalPages
integer (int32)

The total number of result pages that match the search conditions.

Example1
Results
Array of object (UserActivitySearchResult)

See UserActivitySearchResult.

object
UserId
integer (int32)

The user's unique identifier

Example2222
UserExternalId
string | null

The user's external ID, usually a unique identifier from the calling system

Example5A875994-33DE-DE11-92BB-00505690582E
FirstName
string

The user's first name

ExampleJane
LastName
string

The user's last name

ExampleDoe
UserName
string

The user's UserName

Examplejane.doe
OrganizationId
integer (int32)

The unique identifier of the organization the user belongs to

Example1234
ImpersonatingUserId
integer (int32) | null

The user id of the impersonating user (if any)

Example4321
ImpersonatingFirstName
string

The impersonating user's first name (if any)

ExampleSteve
ImpersonatingLastName
string

The impersonating user's last name (if any)

ExampleSmith
RequestTime
integer (int64)

When the user activity occurred (in Unix epoch time)

Example190615
Method
string

The method of the request

ExampleGET
Referrer
string | null

The referring URL (if any)

Url
string | null

The URL of the request

UserAgent
string | null

The reported UserAgent of the request

UserHostAddress
string | null

The reported Host Address of the request

UserLanguages
string | null

The reported languages of the request

ExecutionTimeMS
integer (int64)

The execution time of the request (in milliseconds)

Example55