---
title: "Get users analytics"
method: POST
path: "/api/v1/analytics/users"
tags: ["Analytics"]
---

# Get users analytics

`POST /api/v1/analytics/users`

## Request body

- object
  - `account_ids` integer[] — Restrict to these account ids
  - `product_ids` integer[] — Restrict to these product ids
  - `product_statuses` string[]
  - `promo_codes` string[]
  - `student_ids` integer[]
  - `student_canvas_user_ids` integer[]
  - `enrollment_count_min` integer
  - `enrollment_count_max` integer
  - `last_enrollment_date_from` string, date-time
  - `last_enrollment_date_to` string, date-time
  - `registration_date_from` string, date-time
  - `registration_date_to` string, date-time
  - `registered_through` string[]

## Response `200`

user analytics rows

- object
  - `users` object[], required
    - `id` integer, required
    - `canvas_user_id` integer, required
    - `name` string
    - `email` string
    - `account_id` integer
    - `account_name` string
    - `registered_through` string, required — CANVAS or CATALOG
    - `registered_at` string, required
    - `enrollment_count` integer, required
    - `last_enrolled_at` string, nullable
    - `custom_fields` object[], required — User-defined field values
      - `key` string
      - `value` string
    - `total_rows` integer — Total number of matching rows (pagination total)

---

[API](https://skmtc.net/instructure/apis/canvas-catalog-api.md) · [All operations](https://skmtc.net/instructure/apis/canvas-catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instructure/canvas-catalog-api/revisions/78578cd3e37a/schema)