---
title: "Get user activity and creation report with insights"
method: GET
path: "/business_intelligence/users"
tags: ["Business Intelligence", "Dashboards", "Users"]
---

# Get user activity and creation report with insights

`GET /business_intelligence/users`

Get user activity and creation patterns with insights.
Returns paginated users with filtering and sorting capabilities.

Available sorting fields:
- email: User email address
- views: User views for specified time period
- dashboards_created: Total dashboards created
- workbooks_created: Total workbooks created
- views_received_30d: Views received on user's dashboards (30d)
- last_activity: Last activity date (only sorting, no filtering)

Filtering options:
- views_period: Time period for views column (30, 90, or 180 days, default: 90)
- start_date/end_date: Alternative to views_period - date range will be converted to period
- user: Filter by user email(s)
- license_type: Filter by license type(s)
- insights: Filter by insight types

Insights include:
- properly using Creator license: High creation + high views
- could be Explorer or Viewer: Low/no creation but high views
- candidate for archiving: Very low activity
- definite archiving candidate: No recent activity
- monitor for potential downgrade: High creation but declining views

## Query parameters

- `page` integer — Page number
- `page_size` integer
- `sort_by` string, nullable
- `sort` string, nullable
- `views_period` integer — Time period for views (30, 90, or 180 days)
- `user` string[], nullable
- `license_type` string[], nullable
- `insights` string[], nullable
- `start_date` string, date-time, nullable
- `end_date` string, date-time, nullable
- `instance_name` string[], nullable
- `opportunity_name` string[], nullable
- `size` integer — Page size

## Response `200`

Successful Response

- PageBIUserReportItem
  - `items` BIUserReportItem[], required
    - `email` string, required
    - `views` integer, required
    - `dashboards_created` integer, required
    - `workbooks_created` integer, required
    - `insights` union[], required
      - union
        - string
        - UserInsightItem — Structured insight with name and reasons
          - `name` string, required
          - `reasons` string[], required
    - `last_activity` string, date-time, nullable
    - `full_name` string, nullable
    - `views_received` integer
    - `current_license_type` string, nullable
    - `instance_name` string, nullable
    - `user_rk` string, nullable
    - `opportunities` object[]
  - `total` integer, nullable, required
  - `page` integer, nullable, required
  - `size` integer, nullable, required
  - `pages` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/myaltimate/apis/fastapi.md) · [All operations](https://skmtc.net/myaltimate/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myaltimate/fastapi/versions/aab3fe5c9f05/schema)
