Skip to main content
Get started

Public REST/JSON reference

Course Completion Drop-Off Alerter API

Public BFF API for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges. Part of the Logic Igniter Education Suite.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/coursedropoff.json

Operations rendered

17

Response models rendered

28

POST/api/v1/coursedropoff/courses/sync

Create or run Courses/Sync

Create or run Courses/Sync for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CoursedropoffResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/coursedropoff/courses/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CourseDropoffSyncResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/courses

Get Courses

Get Courses for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/courses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffCoursesResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/courses/{id}/analytics

Get Courses/Id/Analytics

Get Courses/Id/Analytics for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/courses/:id/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CoursedropoffCourseAnalyticsResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/courses/{id}/dropoffs

List course drop-off points

List lesson-level drop-off points for a course.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/courses/:id/dropoffs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffDropOffPointsResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/customers

List CourseDropoff customers

List customers for the CourseDropoff service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CoursedropoffCustomersResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/coursedropoff/customers

Create CourseDropoff customer

Create a customer for the CourseDropoff service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CoursedropoffCreateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/coursedropoff/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201CoursedropoffCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/customers/{id}

Get CourseDropoff customer

Get a customer for the CourseDropoff service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CoursedropoffCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

PUT/api/v1/coursedropoff/customers/{id}

Update CourseDropoff customer

Update a customer for the CourseDropoff service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request body (required)

Schema: CoursedropoffUpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/coursedropoff/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CoursedropoffCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/coursedropoff/nudges/trigger

Create or run Nudges/Trigger

Create or run Nudges/Trigger for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CoursedropoffResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/coursedropoff/nudges/trigger" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CourseDropoffNudgeResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/coursedropoff/nudges/batch

Create or run Nudges/Batch

Create or run Nudges/Batch for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CoursedropoffResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/coursedropoff/nudges/batch" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CourseDropoffBatchNudgeResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/nudges/performance

Get Nudges/Performance

Get Nudges/Performance for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/nudges/performance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffNudgePerformance

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/students

Get Students

Get Students for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/students" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffStudentsResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/students/stalled

Get Students/Stalled

Get Students/Stalled for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/students/stalled" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffStalledStudentsResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/students/{id}/progress

Get Student Progress by enrollment identifier (legacy alias)

Returns progress for the enrollment identified by id. This student-shaped path is retained as a compatibility alias.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/students/:id/progress" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CoursedropoffStudentProgressResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/students/{id}/dropoffs

Get Students/Id/Dropoffs

Get Students/Id/Dropoffs for lesson-level course completion drop-off detection, stalled student lists, and re-engagement nudges.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/students/:id/dropoffs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CourseDropoffDropOffPointsResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/coursedropoff/enrollments/{id}/progress

Get Enrollment Progress

Returns progress for the enrollment identified by id.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/coursedropoff/enrollments/:id/progress" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CoursedropoffStudentProgressResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/coursedropoff/enrollment-progress/ingest

Ingest enrollment progress

Ingest courses, enrollments, and lesson progress for drop-off analysis.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CourseDropoffIngestEnrollmentProgressRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/coursedropoff/enrollment-progress/ingest" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CourseDropoffIngestEnrollmentProgressResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

Data models

CoursedropoffResultRequest

FieldTypeNotes
source_idrequiredstring
workspace_idstring
notesstring
filtersobject

CoursedropoffResult

FieldTypeNotes
idrequiredstringExample: "rec_1042"
workspace_idstringExample: "workspace_123"
statusrequiredenum(pending | active | completed | failed)One of: pending, active, completed, failed
summaryrequiredstring
scorenumber (double)
signalsarray<string>
created_atstring (date-time)
updated_atstring (date-time)

CoursedropoffResultResponse

FieldTypeNotes
datarequiredCoursedropoffResult
itemsarray<CoursedropoffResult>
next_page_tokenstring

CoursedropoffStudentProgressResponse

FieldTypeNotes
datarequiredCoursedropoffStudentProgress

CoursedropoffStudentProgress

FieldTypeNotes
idrequiredstring
student_idrequiredstring
course_idrequiredstring
completion_pctrequirednumber (double)
segmentrequiredstring
last_activity_atstring (date-time)
enrolled_atstring (date-time)

CoursedropoffCourseAnalyticsResponse

FieldTypeNotes
datarequiredCoursedropoffCourseAnalytics

CoursedropoffCourseAnalytics

FieldTypeNotes
idrequiredstring
course_idrequiredstring
completion_raterequirednumber (double)
avg_time_to_complete_daysrequirednumber (double)
drop_off_pointsrequiredarray<CoursedropoffDropOffPoint>

CoursedropoffDropOffPoint

FieldTypeNotes
lesson_idrequiredstring
lesson_orderrequiredinteger
drop_off_countrequiredinteger
drop_off_pctrequirednumber (double)

ErrorResponse

FieldTypeNotes
coderequiredstring
messagerequiredstring
request_idstring

CourseDropoffStudentSummary

FieldTypeNotes
idrequiredstring
student_idrequiredstring
emailrequiredstring
completion_pctrequirednumber (double)
segmentrequiredstring

CourseDropoffStudentsResponse

FieldTypeNotes
itemsrequiredarray<CourseDropoffStudentSummary>
next_page_tokenrequiredstring
total_countrequiredinteger (int32)

CourseDropoffNudgeResult

FieldTypeNotes
idrequiredstring
successrequiredboolean
sent_atstring (date-time)

CourseDropoffNudgePerformance

FieldTypeNotes
idrequiredstring
total_sentrequiredinteger (int32)
openedrequiredinteger (int32)
resumedrequiredinteger (int32)
reengagement_raterequirednumber (double)

CourseDropoffSyncResult

FieldTypeNotes
idstring
courses_syncedinteger (int32)
enrollments_syncedinteger (int32)

CourseDropoffCourse

FieldTypeNotes
idstring
titlestring
lesson_countinteger (int32)
student_countinteger (int32)
completion_ratenumber (double)

CourseDropoffCoursesResponse

FieldTypeNotes
itemsrequiredarray<CourseDropoffCourse>
next_page_tokenrequiredstring
total_countrequiredinteger (int32)

CourseDropoffStalledStudentsResponse

FieldTypeNotes
itemsrequiredarray<CoursedropoffStudentProgress>
next_page_tokenrequiredstring
total_countrequiredinteger (int32)

CourseDropoffDropOffPointsResponse

FieldTypeNotes
itemsrequiredarray<CoursedropoffDropOffPoint>

CourseDropoffBatchNudgeResult

FieldTypeNotes
idstring
nudged_countinteger (int32)

CourseDropoffIngestEnrollmentProgressResult

FieldTypeNotes
idrequiredstring
courses_ingestedrequiredinteger
enrollments_ingestedrequiredinteger
progress_ingestedrequiredinteger

CoursedropoffCustomer

FieldTypeNotes
idrequiredstring
emailrequiredstring
namerequiredstring
planrequiredenum(PLAN_TIER_UNSPECIFIED | PLAN_TIER_STARTER | PLAN_TIER_GROWTH | PLAN_TIER_PRO | PLAN_TIER_ENTERPRISE | PLAN_TIER_SCALE)One of: PLAN_TIER_UNSPECIFIED, PLAN_TIER_STARTER, PLAN_TIER_GROWTH, PLAN_TIER_PRO, PLAN_TIER_ENTERPRISE, PLAN_TIER_SCALE
statusrequiredenum(CUSTOMER_STATUS_UNSPECIFIED | CUSTOMER_STATUS_ACTIVE | CUSTOMER_STATUS_INACTIVE | CUSTOMER_STATUS_SUSPENDED | CUSTOMER_STATUS_CANCELLED | CUSTOMER_STATUS_TRIAL | CUSTOMER_STATUS_PENDING | CUSTOMER_STATUS_PAUSED)One of: CUSTOMER_STATUS_UNSPECIFIED, CUSTOMER_STATUS_ACTIVE, CUSTOMER_STATUS_INACTIVE, CUSTOMER_STATUS_SUSPENDED, CUSTOMER_STATUS_CANCELLED, CUSTOMER_STATUS_TRIAL, CUSTOMER_STATUS_PENDING, CUSTOMER_STATUS_PAUSED
stripe_customer_idrequiredstring
max_targetsrequiredinteger
created_atstring (date-time)
updated_atstring (date-time)

CoursedropoffCustomersResponse

FieldTypeNotes
customersrequiredarray<CoursedropoffCustomer>
next_page_tokenrequiredstring
total_countrequiredinteger

CoursedropoffCreateCustomerRequest

FieldTypeNotes
emailstring
namestring
planstring

CoursedropoffUpdateCustomerRequest

FieldTypeNotes
namestring
planstring
statusstring

CourseDropoffIngestEnrollmentProgressRequest

FieldTypeNotes
coursesarray<CourseDropoffCourseInput>
enrollmentsarray<CourseDropoffEnrollmentInput>
progressarray<CourseDropoffProgressInput>

CourseDropoffCourseInput

FieldTypeNotes
course_idstring
titlestring
lesson_countinteger

CourseDropoffEnrollmentInput

FieldTypeNotes
enrollment_idstring
course_idstring
student_idstring
student_emailstring
student_namestring
enrolled_atstring (date-time)
completed_atstring (date-time)
statusstring

CourseDropoffProgressInput

FieldTypeNotes
enrollment_idstring
course_idstring
student_idstring
lesson_idstring
lesson_orderinteger
completed_atstring (date-time)
time_spent_minutesinteger