Analytics
post
Authorizations
Body
account_idsinteger[]Optional
List of account ids
product_idsinteger[]Optional
List of product ids
product_statusesstring[]Optional
List of product statuses (OPEN, CLOSED, and/or DELETED)
creation_date_fromstringOptional
Creation date from
creation_date_tostringOptional
Creation date to
enrollment_count_minintegerOptional
Enrollment count minimum
enrollment_count_maxintegerOptional
Enrollment count maximum
completion_count_minintegerOptional
Completion count minimum
completion_count_maxintegerOptional
Completion count maximum
dropped_count_minintegerOptional
Dropped count minimum
dropped_count_maxintegerOptional
Dropped count maximum
listing_price_minnumberOptional
Listing price minimum
listing_price_maxnumberOptional
Listing price maximum
promo_codesstring[]Optional
List of promotion code states (APPLIED and/or NOT_APPLIED)
revenue_minnumberOptional
Revenue minimum
revenue_maxnumberOptional
Revenue maximum
certificate_offeredbooleanOptional
Certificate offered for the product
Responses
200
Getting products analytics
application/json
post
POST /api/v1/analytics/products HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 389
{
"account_ids": [
1
],
"product_ids": [
1
],
"product_statuses": [
"text"
],
"creation_date_from": "text",
"creation_date_to": "text",
"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,
"promo_codes": [
"text"
],
"revenue_min": 1,
"revenue_max": 1,
"certificate_offered": true
}200
Getting products analytics
{
"products": [
{
"account_id": 3,
"account_name": "Sub-Account 1",
"product": {
"name": "Course 1",
"id": 5,
"url": "https://www.my-catalog.edu/listings/1/edit",
"sku": "sku"
},
"product_status": "OPEN",
"created_at": "2023-06-05T14:46:59.944581+02:00",
"canvas_course_id": 11,
"enrollment_count": 7,
"dropped_count": 3,
"completion_count": 2,
"currency": "USD",
"list_price": 10,
"promo_codes": [
"PROMO1",
"PROMO2"
],
"discount": 10,
"revenue": 60,
"credits": 5,
"certificate_offered": true,
"instructor_names": [
"Instructor 1",
"Instructor 2"
],
"primary_instructor_name": "Instructor 1",
"archived_at": "2024-08-01T14:46:59.944581+02:00"
}
]
}post
Authorizations
Body
account_idsinteger[]Optional
List of account ids
product_idsinteger[]Optional
List of product ids
product_statusesstring[]Optional
List of product statuses (OPEN, CLOSED, and/or DELETED)
student_idsinteger[]Optional
List of student ids(catalog user id)
student_canvas_user_idsinteger[]Optional
List of student ids(canvas user id)
enrollment_date_fromstringOptional
Enrollment date from
enrollment_date_tostringOptional
Enrollment date to
enrollment_statusesstring[]Optional
List of enrollment statuses (ACTIVE, COMPLETED, DROPPED and/or CONCLUDED)
completion_date_fromstringOptional
Completion date from
completion_date_tostringOptional
Completion date to
Responses
200
Getting enrollments analytics
application/json
post
POST /api/v1/analytics/enrollments HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 260
{
"account_ids": [
1
],
"product_ids": [
1
],
"product_statuses": [
"text"
],
"student_ids": [
1
],
"student_canvas_user_ids": [
1
],
"enrollment_date_from": "text",
"enrollment_date_to": "text",
"enrollment_statuses": [
"text"
],
"completion_date_from": "text",
"completion_date_to": "text"
}200
Getting enrollments analytics
{
"enrollments": [
{
"id": 25,
"account_id": 3,
"account_name": "Sub-Account 1",
"product": {
"name": "Course 1",
"id": 5,
"url": "https://www.my-catalog.edu/listings/1/edit",
"sku": "sku"
},
"product_status": "OPEN",
"canvas_course_id": 11,
"student": {
"canvas_user_id": 1,
"name": "User 15",
"email": "[email protected]",
"canvas_user_id_string": "1"
},
"requirement_count": 4,
"requirement_completed_count": 2,
"requirement_completed_percentage": 2,
"created_at": "2023-06-05T14:46:59.944581+02:00",
"completed_at": "2023-06-29T12:13:27+02:00",
"enrollment_status": "COMPLETED",
"certificate_attainable": true,
"certificate_offered": true,
"custom_fields": [
{
"key": "text_udf",
"value": "awesome udf"
},
{
"key": "checkbox_udf",
"value": "1"
}
],
"certificate_url": "https://www.my-catalog.edu/admin/certificates/1.pdf?user_id=1",
"archived_at": "2024-08-01T14:46:59.944581+02:00"
}
]
}post
Authorizations
Body
account_idsinteger[]Optional
List of account ids
product_idsinteger[]Optional
List of product ids
product_statusesstring[]Optional
List of product statuses (OPEN, CLOSED, and/or DELETED)
student_idsinteger[]Optional
List of student ids(catalog user id)
student_canvas_user_idsinteger[]Optional
List of student ids(canvas user id)
purchaser_idsinteger[]Optional
List of purchaser ids(catalog user id)
purchaser_canvas_user_idsinteger[]Optional
List of purchaser ids(canvas user id)
bulk_purchases_onlybooleanOptional
Bulk purchases only
purchase_date_fromstringOptional
Purchase date from
purchase_date_tostringOptional
Purchase date to
order_feestring[]Optional
List of order fee types (FREE and/or PAID)
listing_price_minnumberOptional
Listing price minimum
listing_price_maxnumberOptional
Listing price maximum
promo_codesstring[]Optional
List of promotion code states (APPLIED and/or NOT_APPLIED)
revenue_minnumberOptional
Revenue minimum
revenue_maxnumberOptional
Revenue maximum
Responses
200
Getting orders analytics
application/json
post
POST /api/v1/analytics/orders HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 366
{
"account_ids": [
1
],
"product_ids": [
1
],
"product_statuses": [
"text"
],
"student_ids": [
1
],
"student_canvas_user_ids": [
1
],
"purchaser_ids": [
1
],
"purchaser_canvas_user_ids": [
1
],
"bulk_purchases_only": true,
"purchase_date_from": "text",
"purchase_date_to": "text",
"order_fee": [
"text"
],
"listing_price_min": 1,
"listing_price_max": 1,
"promo_codes": [
"text"
],
"revenue_min": 1,
"revenue_max": 1
}200
Getting orders analytics
{
"orders": [
{
"account_id": 3,
"account_name": "Sub-Account 1",
"product": {
"name": "Course 1",
"id": 5,
"url": "https://www.my-catalog.edu/listings/1/edit",
"sku": "sku"
},
"product_status": "OPEN",
"canvas_course_id": 11,
"purchaser": {
"id": 1,
"canvas_user_id": 1,
"name": "Purchaser 1",
"email": "[email protected]",
"canvas_user_id_string": "1"
},
"purchased_at": "2023-07-02T23:30:59.052239+02:00",
"order_id": 81,
"order_item_id": 123,
"reference_id": "PR-81-82",
"list_price": 5,
"currency": "USD",
"promo_codes": [
"PROMO1",
"PROMO2"
],
"discount": 10,
"revenue": 5,
"bulk_purchase": true,
"seat_count": 3,
"bulk_enrollments": [
{
"id": 141,
"canvas_user_id": 74,
"name": "User 17",
"email": "[email protected]",
"canvas_user_id_string": "74"
},
{
"id": 138,
"canvas_user_id": 73,
"name": "User 16",
"email": "[email protected]",
"canvas_user_id_string": "73"
}
],
"last_modification_date": "2023-07-09T23:30:59.052239+02:00",
"revenue_change_history": [
{
"modification_date": "2023-07-09T23:30:59.052239+02:00",
"new_value": 5,
"new_value_currency": "USD",
"old_value": 2,
"old_value_currency": "USD",
"reason": "This is very important",
"user_name": "[email protected]",
"user_profile_link": "https://www.my-catalog.edu/accounts/2/users/1"
},
{
"modification_date": "2023-07-08T23:30:59.052239+02:00",
"new_value": 2,
"new_value_currency": "USD",
"old_value": 11,
"old_value_currency": "USD",
"reason": "This is important",
"user_name": "[email protected]",
"user_profile_link": "https://www.my-catalog.edu/accounts/2/users/2"
}
]
}
]
}post
Authorizations
Body
account_idsinteger[]Optional
List of account ids
student_idsinteger[]Optional
List of student ids(catalog user id)
student_canvas_user_idsinteger[]Optional
List of student ids(canvas user id)
enrollment_count_minintegerOptional
Enrollment count minimum
enrollment_count_maxintegerOptional
Enrollment count maximum
last_enrollment_date_fromstringOptional
Last enrollment date from
last_enrollment_date_tostringOptional
Last enrollment date to
registration_date_fromstringOptional
Registration date from
registration_date_tostringOptional
Registration date to
registered_throughstring[]Optional
List of registration sources (CANVAS and/or CATALOG)
Responses
200
Getting users analytics
application/json
post
POST /api/v1/analytics/users HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 277
{
"account_ids": [
1
],
"student_ids": [
1
],
"student_canvas_user_ids": [
1
],
"enrollment_count_min": 1,
"enrollment_count_max": 1,
"last_enrollment_date_from": "text",
"last_enrollment_date_to": "text",
"registration_date_from": "text",
"registration_date_to": "text",
"registered_through": [
"text"
]
}200
Getting users analytics
{
"users": [
{
"id": 150,
"canvas_user_id": 77,
"name": "User 19",
"email": "[email protected]",
"account_id": 3,
"account_name": "Sub-Account 1",
"registered_through": "CATALOG",
"registered_at": "2023-07-03T15:03:57.597+02:00",
"enrollment_count": 2,
"last_enrolled_at": "2023-07-06T17:30:50.991764+02:00",
"custom_fields": [
{
"key": "text_udf",
"value": "awesome udf"
},
{
"key": "checkbox_udf",
"value": "1"
}
]
}
]
}Last updated
Was this helpful?