INinstructure
Analytics

Get orders analytics

post/api/v1/analytics/orders

Request

  • Base URL
    https://catalog.example.edu
  • Auth
    API key in header Authorization

Request body

account_idsinteger[]

Restrict to these account ids

product_idsinteger[]

Restrict to these product ids

product_statusesstring[]
promo_codesstring[]
student_idsinteger[]
student_canvas_user_idsinteger[]
purchaser_idsinteger[]
purchaser_canvas_user_idsinteger[]
bulk_purchases_onlyboolean
purchase_date_fromstring date-time
purchase_date_tostring date-time
order_feenumber
listing_price_minnumber
listing_price_maxnumber
revenue_minnumber
revenue_maxnumber

Response

order analytics rows

Changes

No recorded changes to this operation across all 1 revision of this API.