Analytics

Get products analytics

post

Authorizations

AuthorizationstringRequired

Body

account_idsinteger[]Optional

Restrict to these account ids

product_idsinteger[]Optional

Restrict to these product ids

creation_date_fromstring · date-timeOptional

creation_date_tostring · date-timeOptional

enrollment_count_minintegerOptional

enrollment_count_maxintegerOptional

completion_count_minintegerOptional

completion_count_maxintegerOptional

dropped_count_minintegerOptional

dropped_count_maxintegerOptional

listing_price_minnumberOptional

listing_price_maxnumberOptional

revenue_minnumberOptional

revenue_maxnumberOptional

certificate_offeredbooleanOptional

Responses

200

product analytics rows

application/json

post/api/v1/analytics/products

POST /api/v1/analytics/products HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "account_ids": [
    1
  ],
  "product_ids": [
    1
  ],
  "product_statuses": [
    "OPEN"
  ],
  "promo_codes": [
    "APPLIED"
  ],
  "creation_date_from": "2026-01-01T00:00:00.000Z",
  "creation_date_to": "2026-01-01T00:00:00.000Z",
  "enrollment_count_min": 1,
  "enrollment_count_max": 1,
  "completion_count_min": 1,
  "completion_count_max": 1,
  "dropped_count_min": 1,
  "dropped_count_max": 1,
  "listing_price_min": 1,
  "listing_price_max": 1,
  "revenue_min": 1,
  "revenue_max": 1,
  "certificate_offered": true
}

200

product analytics rows

{
  "products": [
    {
      "account_id": 1,
      "account_name": "text",
      "product": {
        "name": "text",
        "id": 1,
        "url": "text",
        "sku": "text"
      },
      "product_status": "text",
      "created_at": "text",
      "canvas_course_id": 1,
      "canvas_section_id": 1,
      "enrollment_count": 1,
      "dropped_count": 1,
      "completion_count": 1,
      "currency": "text",
      "list_price": 1,
      "promo_codes": [
        "text"
      ],
      "discount": 1,
      "revenue": 1,
      "credits": 1,
      "certificate_offered": true,
      "instructor_names": [
        "text"
      ],
      "primary_instructor_name": "text",
      "archived_at": "text",
      "total_rows": 1
    }
  ]
}

Get enrollments analytics

post

Authorizations

AuthorizationstringRequired

Body

account_idsinteger[]Optional

Restrict to these account ids

product_idsinteger[]Optional

Restrict to these product ids

student_idsinteger[]Optional

student_canvas_user_idsinteger[]Optional

enrollment_date_fromstring · date-timeOptional

enrollment_date_tostring · date-timeOptional

completion_date_fromstring · date-timeOptional

completion_date_tostring · date-timeOptional

Responses

200

enrollment analytics rows

application/json

post/api/v1/analytics/enrollments

POST /api/v1/analytics/enrollments HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "account_ids": [
    1
  ],
  "product_ids": [
    1
  ],
  "product_statuses": [
    "OPEN"
  ],
  "promo_codes": [
    "APPLIED"
  ],
  "student_ids": [
    1
  ],
  "student_canvas_user_ids": [
    1
  ],
  "enrollment_date_from": "2026-01-01T00:00:00.000Z",
  "enrollment_date_to": "2026-01-01T00:00:00.000Z",
  "enrollment_statuses": [
    "ACTIVE"
  ],
  "completion_date_from": "2026-01-01T00:00:00.000Z",
  "completion_date_to": "2026-01-01T00:00:00.000Z"
}

200

enrollment analytics rows

{
  "enrollments": [
    {
      "id": 1,
      "account_id": 1,
      "account_name": "text",
      "product": {
        "name": "text",
        "id": 1,
        "url": "text",
        "sku": "text"
      },
      "product_status": "text",
      "canvas_course_id": 1,
      "canvas_section_id": 1,
      "student": {
        "canvas_user_id": 1,
        "name": "text",
        "email": "text",
        "canvas_user_id_string": "text"
      },
      "requirement_count": 1,
      "requirement_completed_count": 1,
      "requirement_completed_percentage": 1,
      "created_at": "text",
      "completed_at": "text",
      "enrollment_status": "text",
      "certificate_attainable": true,
      "certificate_offered": true,
      "custom_fields": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "certificate_url": "text",
      "archived_at": "text",
      "total_rows": 1
    }
  ]
}

Get orders analytics

post

Authorizations

AuthorizationstringRequired

Body

account_idsinteger[]Optional

Restrict to these account ids

product_idsinteger[]Optional

Restrict to these product ids

student_idsinteger[]Optional

student_canvas_user_idsinteger[]Optional

purchaser_idsinteger[]Optional

purchaser_canvas_user_idsinteger[]Optional

bulk_purchases_onlybooleanOptional

purchase_date_fromstring · date-timeOptional

purchase_date_tostring · date-timeOptional

order_feenumberOptional

listing_price_minnumberOptional

listing_price_maxnumberOptional

revenue_minnumberOptional

revenue_maxnumberOptional

Responses

200

order analytics rows

application/json

post/api/v1/analytics/orders

POST /api/v1/analytics/orders HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 402

{
  "account_ids": [
    1
  ],
  "product_ids": [
    1
  ],
  "product_statuses": [
    "OPEN"
  ],
  "promo_codes": [
    "APPLIED"
  ],
  "student_ids": [
    1
  ],
  "student_canvas_user_ids": [
    1
  ],
  "purchaser_ids": [
    1
  ],
  "purchaser_canvas_user_ids": [
    1
  ],
  "bulk_purchases_only": true,
  "purchase_date_from": "2026-01-01T00:00:00.000Z",
  "purchase_date_to": "2026-01-01T00:00:00.000Z",
  "order_fee": 1,
  "listing_price_min": 1,
  "listing_price_max": 1,
  "revenue_min": 1,
  "revenue_max": 1
}

200

order analytics rows

{
  "orders": [
    {
      "account_id": 1,
      "account_name": "text",
      "product": {
        "name": "text",
        "id": 1,
        "url": "text",
        "sku": "text"
      },
      "product_status": "text",
      "canvas_course_id": 1,
      "canvas_section_id": 1,
      "purchaser": {
        "id": 1,
        "canvas_user_id": 1,
        "name": "text",
        "email": "text",
        "canvas_user_id_string": "text"
      },
      "purchased_at": "text",
      "order_id": 1,
      "order_item_id": 1,
      "reference_id": "text",
      "list_price": 1,
      "currency": "text",
      "promo_codes": [
        "text"
      ],
      "discount": 1,
      "revenue": 1,
      "bulk_purchase": true,
      "seat_count": 1,
      "bulk_enrollments": [
        {
          "id": 1,
          "canvas_user_id": 1,
          "name": "text",
          "email": "text",
          "canvas_user_id_string": "text"
        }
      ],
      "last_modification_date": "text",
      "revenue_change_history": [
        {
          "modification_date": "text",
          "new_value": 1,
          "new_value_currency": "text",
          "old_value": 1,
          "old_value_currency": "text",
          "reason": "text",
          "user_name": "text",
          "user_profile_link": "text"
        }
      ],
      "total_rows": 1
    }
  ]
}

Get users analytics

post

Authorizations

AuthorizationstringRequired

Body

account_idsinteger[]Optional

Restrict to these account ids

product_idsinteger[]Optional

Restrict to these product ids

student_idsinteger[]Optional

student_canvas_user_idsinteger[]Optional

enrollment_count_minintegerOptional

enrollment_count_maxintegerOptional

last_enrollment_date_fromstring · date-timeOptional

last_enrollment_date_tostring · date-timeOptional

registration_date_fromstring · date-timeOptional

registration_date_tostring · date-timeOptional

Responses

200

user analytics rows

application/json

post/api/v1/analytics/users

POST /api/v1/analytics/users HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "account_ids": [
    1
  ],
  "product_ids": [
    1
  ],
  "product_statuses": [
    "OPEN"
  ],
  "promo_codes": [
    "APPLIED"
  ],
  "student_ids": [
    1
  ],
  "student_canvas_user_ids": [
    1
  ],
  "enrollment_count_min": 1,
  "enrollment_count_max": 1,
  "last_enrollment_date_from": "2026-01-01T00:00:00.000Z",
  "last_enrollment_date_to": "2026-01-01T00:00:00.000Z",
  "registration_date_from": "2026-01-01T00:00:00.000Z",
  "registration_date_to": "2026-01-01T00:00:00.000Z",
  "registered_through": [
    "CANVAS"
  ]
}

200

user analytics rows

{
  "users": [
    {
      "id": 1,
      "canvas_user_id": 1,
      "name": "text",
      "email": "text",
      "account_id": 1,
      "account_name": "text",
      "registered_through": "text",
      "registered_at": "text",
      "enrollment_count": 1,
      "last_enrolled_at": "text",
      "custom_fields": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "total_rows": 1
    }
  ]
}