List portal user activity

1 min

GET

https://api.detected.app/api/v2/public/portal-users/activity

Returns activity recorded for portal users, such as login events. By default it returns all activity for all portal users in your account. Narrow the results with filters such as profile_id.

The supported activity types (types) are:

access_log: login events, including IP address, location, browser and session information

More activity types may be added in future.

This endpoint is paginated. Use the page parameter to request further pages. The meta and links objects in the response describe the current page and link to the others.

idstringID of the portal activity.

user_idstringFilter by portal user ID.

profile_idstringFilter results by profile ID.

emailstringFilter by portal user email address.

ipstringFilter by IP address.

typesstringFilter by activity type. Currently only <code>access_log</code> is supported.

namestringFilter by portal user name.

order_bystringDirection to sort the results in: <code>asc</code> for ascending or <code>desc</code> for descending. Use it together with <code>sort_by</code>; it has no effect if <code>sort_by</code> is omitted. The default is <code>asc</code>.

sort_bystringThe field to sort the results by. Use it together with <code>order_by</code> to choose the direction; if <code>order_by</code> is omitted, results are sorted in ascending order (<code>asc</code>). If <code>sort_by</code> is omitted, results are returned in no guaranteed order. Supported fields: <ul> <li><code>id</code></li> <li><code>created_at</code></li> <li><code>updated_at</code></li> </ul>

pagestringPage number of the results to return, starting from 1. The number of items per page is returned in <code>meta.per_page</code>.

acceptstringGenerated from available response content types

200OK

401Unauthorized. The access token is missing, invalid or has expired.

404Not Found. The requested resource does not exist, or is not available to your account.

422Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.

429Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.

curl --request GET \
     --url https://api.detected.app/api/v2/public/portal-users/activity \
     --header 'accept: application/json'

Have a question?

Our knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.