Loading ...

REST API: Get All User Activity | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Get All User Activity
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 34

REST API: Get All User Activity

Open API Guide
GET/api/users/activity

Get activity log entries for all users. A caller can always read their own entries by sending their own UserID. Reading another user's entries needs the Admin Entity View permission on users. Reading everyone's needs the right to manage the recent activity feed, either site-wide or in the space named by SpaceID.

The date filters take a date or a full datetime. A date alone is read as midnight at the start of that day, so a ToDate of 1/26/2024 leaves out everything from January 26. Use the form YYYY-MM-DDTHH:MM:SS for FromDate and ToDate to narrow a window to the hour or minute.

These filters did not work on this endpoint before version 9.59, although the same filters on the per-user activity endpoint did. If a date range seems to be ignored, check the site's version before assuming the request is wrong.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

ParameterTypeRequiredLocationDescription
ActivityIntegerNOQuerySee REST API: Activity Action ID for definitions and details. Send the number or the name (for example View). A word that is not an activity name is ignored. A number the list does not define returns no entries. A number of four digits or more answers 200 with IsError true and a database error in ResponseMessage. A comma list is read as the values combined (1,2 reads as 3).
StartPageIntegerNOQueryPage of results to return. Default: 1. A value that is not a whole number is ignored. A value below 1 answers 200 with IsError true.
PageLengthIntegerNOQueryNumber of results to return per page. Default: 30. A value that is not a whole number is ignored. A value below 1 answers 200 with IsError true.
SpaceIDIntegerNOQueryID of the space where the activity occurred. Omit, or send -1, for no filter. Send 0 for activity outside any space. A value that is not a whole number is ignored, as if it were left out.
UserIDIntegerNOQueryID of the user whose activity is returned. Omit, or send -1, for no filter. With no filter, entries recorded with no signed-in user (UserID 0) are left out. Send 0 to get them. A value that is not a whole number is ignored, as if it were left out.
EntityTypeIDIntegerNOQueryEntity type of the activity; see REST API: System Entity Types. Omit, or send -1, for no filter. Sending 1 (Forum) returns forum, forum group, forum topic, and forum post activity together. A value that is not a whole number is ignored, as if it were left out.
ContentTypeIDIntegerNOQueryReturn only the entries for items of this content type. Each entry for such an item carries the number in its ContentTypeID field. A value that is not a whole number is ignored, as if it were left out.
EntityIDIntegerNOQueryReturn only the entries for this item, for example a ContentID. A value that is not a whole number is ignored, as if it were left out.
FromDateStringNOQueryReturn only the entries recorded after this date and time, in UTC. Leave it out for no lower limit. A value that is not a date is ignored.
ToDateStringNOQueryReturn only the entries recorded at or before this date and time, in UTC. Leave it out for no upper limit. A value that is not a date is ignored.
ImpersonatorIntegerNOQueryReturn only the entries recorded while this UserID was impersonating the acting user. Send -1 for no filter. A value that is not a whole number is ignored, as if it were left out.
PersonaIDIntegerNOQueryReturn only the activity of users in this persona. Send -1 for no filter. Ignored when UserID is sent. A persona ID that does not exist answers 200 with IsError true and 403 Forbidden in ResponseMessage. A persona that matches no users answers 200 with IsError true and No activity found for this Persona. A value that is not a whole number is ignored, as if it were left out.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/users/activity?FromDate=1/1/2024&ToDate=1/26/2024&StartPage=1&PageLength=3

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ActivityLogID": 119556,
      "UserID": 376,
      "UserDisplayName": "Alexis Fox",
      "UserProfileURL": "https://your-site.com/people/admin",
      "ActivityActionEnum": 64,
      "ActivityActionText": "View",
      "PageURL": "https://your-site.com/",
      "ActivityDate": "2024-01-25T18:38:46.003",
      "ActivityDateString": "12 minutes ago",
      "EntityID": 3,
      "EntityType": 75,
      "EntityTypeText": "Page Builder Page",
      "ContentTitle": "Homepage",
      "IPAddress": "203.0.113.10",
      "BrowserType": 1,
      "OperatingSys": 1,
      "SpaceID": 0,
      "SpaceName": "Top level community",
      "OldValue": "",
      "NewValue": "",
      "PermissionCheckAuthorID": 0,
      "IsContentPubliclyAccessible": false,
      "ParentContentID": 0,
      "IsSpaceLevel": false
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "403 Forbidden"
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestNot returned for a malformed value: a parameter that is not of its type is treated as left out, and the call answers 200.None needed; send the parameter in its documented type to apply it.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: a caller without the right to read this activity gets 200 with IsError true and 403 Forbidden in ResponseMessage.Read IsError on every response.
500 Server ErrorNot returned: a failure answers 200 with IsError true and the error text in ResponseMessage.Read IsError on every response.
200 with IsErrorThe query could not be run, and ResponseMessage carries the error. The causes are an Activity number of four digits or more, a StartPage or PageLength below 1, a SpaceID, EntityTypeID, or ContentTypeID of five digits or more, and a PersonaID that matches no users.Read IsError on every response, and check the value named in the cause.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages