> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get user activity analytics > Track how users engage with the portal including login trends, activity by module, and activity by company role. Filter by company, user, role, or date range. ## OpenAPI ````yaml /openapi.json get /api/public/v1/analytics/user-activity openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production environment security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics paths: /api/public/v1/analytics/user-activity: get: tags: - Analytics summary: Get user activity analytics description: >- Track how users engage with the portal including login trends, activity by module, and activity by company role. Filter by company, user, role, or date range. parameters: - schema: type: string format: uuid description: Filter by company ID required: false description: Filter by company ID name: companyId in: query - schema: type: string format: uuid description: Filter by user ID required: false description: Filter by user ID name: userId in: query - schema: type: string maxLength: 100 description: Filter by company role (e.g., vCIO) required: false description: Filter by company role (e.g., vCIO) name: roleType in: query - schema: type: string description: Start date (ISO 8601) required: false description: Start date (ISO 8601) name: dateFrom in: query - schema: type: string description: End date (ISO 8601) required: false description: End date (ISO 8601) name: dateTo in: query responses: '200': description: User activity analytics content: application/json: schema: $ref: '#/components/schemas/UserActivityResponse' '400': description: Invalid query parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden - Missing required scope (analytics.read) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: UserActivityResponse: type: object properties: data: $ref: '#/components/schemas/UserActivity' required: - data ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error UserActivity: type: object properties: summary: $ref: '#/components/schemas/UserActivitySummary' loginTrend: type: array items: $ref: '#/components/schemas/LoginTrend' description: Login trend by week userLogins: type: array items: $ref: '#/components/schemas/UserLastLogin' description: User login details activityByModule: type: array items: $ref: '#/components/schemas/ActivityByModule' description: Activity by module activityByRole: type: array items: $ref: '#/components/schemas/ActivityByRole' description: Activity by company role required: - summary - loginTrend - userLogins - activityByModule - activityByRole UserActivitySummary: type: object properties: totalUsers: type: number description: Total users activeUsers: type: number description: Active users (logged in last 30 days) activeRate: type: number description: Active rate (%) required: - totalUsers - activeUsers - activeRate LoginTrend: type: object properties: period: type: string description: Period (date) logins: type: number description: Number of logins required: - period - logins UserLastLogin: type: object properties: userId: type: string format: uuid description: User ID name: type: string nullable: true description: User name email: type: string description: User email lastLogin: type: string nullable: true format: date-time description: Last login timestamp companyId: type: string nullable: true format: uuid description: Company ID companyName: type: string nullable: true description: Company name required: - userId - name - email - lastLogin - companyId - companyName ActivityByModule: type: object properties: module: type: string description: Module name views: type: number description: View count creates: type: number description: Create count updates: type: number description: Update count deletes: type: number description: Delete count required: - module - views - creates - updates - deletes ActivityByRole: type: object properties: role: type: string description: Role name totalActions: type: number description: Total actions uniqueUsers: type: number description: Unique users required: - role - totalActions - uniqueUsers securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ````