Skip to main content
GET
/
api
/
public
/
v1
/
analytics
/
user-activity
Get user activity analytics
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/analytics/user-activity \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "summary": {
      "totalUsers": 123,
      "activeUsers": 123,
      "activeRate": 123
    },
    "loginTrend": [
      {
        "period": "<string>",
        "logins": 123
      }
    ],
    "userLogins": [
      {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "lastLogin": "2023-11-07T05:31:56Z",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyName": "<string>"
      }
    ],
    "activityByModule": [
      {
        "module": "<string>",
        "views": 123,
        "creates": 123,
        "updates": 123,
        "deletes": 123
      }
    ],
    "activityByRole": [
      {
        "role": "<string>",
        "totalActions": 123,
        "uniqueUsers": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
companyId
string<uuid>

Filter by company ID

​
userId
string<uuid>

Filter by user ID

​
roleType
string

Filter by company role (e.g., vCIO)

Maximum string length: 100
​
dateFrom
string

Start date (ISO 8601)

​
dateTo
string

End date (ISO 8601)

Response

User activity analytics

​
data
object
required