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

# Get orders analytics

`POST /api/v1/analytics/orders`

## 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[]
  - `purchaser_ids` integer[]
  - `purchaser_canvas_user_ids` integer[]
  - `bulk_purchases_only` boolean
  - `purchase_date_from` string, date-time
  - `purchase_date_to` string, date-time
  - `order_fee` number
  - `listing_price_min` number
  - `listing_price_max` number
  - `revenue_min` number
  - `revenue_max` number

## Response `200`

order analytics rows

- object
  - `orders` object[], 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
    - `purchaser` object
      - `id` integer
      - `canvas_user_id` integer
      - `name` string
      - `email` string
      - `canvas_user_id_string` string
    - `purchased_at` string, required
    - `order_id` integer, required
    - `order_item_id` integer, required
    - `reference_id` string
    - `list_price` number
    - `currency` string
    - `promo_codes` string[], required
    - `discount` number
    - `revenue` number
    - `bulk_purchase` boolean, required
    - `seat_count` integer
    - `bulk_enrollments` object[] — Seats invited for a bulk purchase
      - `id` integer
      - `canvas_user_id` integer
      - `name` string
      - `email` string
      - `canvas_user_id_string` string
    - `last_modification_date` string, nullable
    - `revenue_change_history` object[], required — Audit trail of revenue changes
      - `modification_date` string
      - `new_value` number
      - `new_value_currency` string
      - `old_value` number
      - `old_value_currency` string
      - `reason` string
      - `user_name` string
      - `user_profile_link` 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)