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

# Get enrollments analytics

`POST /api/v1/analytics/enrollments`

## 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_date_from` string, date-time
  - `enrollment_date_to` string, date-time
  - `enrollment_statuses` string[]
  - `completion_date_from` string, date-time
  - `completion_date_to` string, date-time

## Response `200`

enrollment analytics rows

- object
  - `enrollments` object[], required
    - `id` integer, required
    - `account_id` integer, required
    - `account_name` string
    - `product` object, required — The listing
      - `name` string
      - `id` integer, required
      - `url` string
      - `sku` string, nullable
    - `product_status` string
    - `canvas_course_id` integer
    - `canvas_section_id` integer
    - `student` object
      - `canvas_user_id` integer
      - `name` string
      - `email` string
      - `canvas_user_id_string` string
    - `requirement_count` integer
    - `requirement_completed_count` integer
    - `requirement_completed_percentage` integer
    - `created_at` string, required
    - `completed_at` string, nullable
    - `enrollment_status` string — ACTIVE, COMPLETED, DROPPED or CONCLUDED
    - `certificate_attainable` boolean, required
    - `certificate_offered` boolean, required
    - `custom_fields` object[], required — User-defined field values
      - `key` string
      - `value` string
    - `certificate_url` string, nullable
    - `archived_at` string, nullable
    - `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)