{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/GetLmsCourseProgressionsPositiveResponse", "title": "GetLmsCourseProgressionsPositiveResponse", "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "next": { "type": [ "string", "null" ], "description": "Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages." }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "user_id": { "type": "string", "description": "The Kombo ID of the user this progression relates to. The ID can be used to retrieve the user from the `get users` endpoint." }, "course_revision_id": { "type": "string", "description": "The Kombo ID of the revision this progression relates to. The ID can be used to retrieve the revision from the `get courses` endpoint." }, "status": { "type": [ "string", "null" ], "enum": [ "ENROLLED", "IN_PROGRESS", "COMPLETED", "DROPPED" ], "description": "Current status of the learner in this course revision." }, "enrolled_at": { "description": "Date when the user enrolled in the course revision.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "completed_at": { "description": "Date when the user completed the course revision.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "changed_at": { "description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.", "type": "string", "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_deleted_at": { "description": "The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_data": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it." }, "user": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "first_name": { "type": [ "string", "null" ], "description": "The user's first name." }, "last_name": { "type": [ "string", "null" ], "description": "The user's last name." }, "work_email": { "type": [ "string", "null" ], "description": "The user's work email address." } }, "required": [ "id", "remote_id", "first_name", "last_name", "work_email" ], "examples": [ { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32", "first_name": "Sarah", "last_name": "Johnson", "work_email": "sarah.johnson@example.com" } ] }, "course_revision": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "title": { "type": [ "string", "null" ], "description": "The title of the course revision." }, "course": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." } }, "required": [ "id", "remote_id" ] } }, "required": [ "id", "remote_id", "title", "course" ] } }, "required": [ "id", "remote_id", "user_id", "course_revision_id", "status", "enrolled_at", "completed_at", "changed_at", "remote_deleted_at", "remote_data", "user", "course_revision" ], "examples": [ { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "progress-12345", "user_id": "7xPdr68N8kG9EzLwjsN9xyz", "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz", "status": "COMPLETED", "enrolled_at": "2022-08-07T14:01:29.196Z", "completed_at": "2022-08-07T14:01:29.196Z", "changed_at": "2022-08-07T14:01:29.196Z", "remote_deleted_at": null, "remote_data": null, "user": { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32", "first_name": "Sarah", "last_name": "Johnson", "work_email": "sarah.johnson@example.com" }, "course_revision": { "id": "3KMdr68N8kG9EzLwjsN9aoz", "remote_id": "revision-12345", "title": "Building LMS integrations with Kombo", "course": { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32" } } } ] } } }, "required": [ "next", "results" ], "examples": [ { "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=", "results": [ { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "progress-12345", "user_id": "7xPdr68N8kG9EzLwjsN9xyz", "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz", "status": "COMPLETED", "enrolled_at": "2022-08-07T14:01:29.196Z", "completed_at": "2022-08-07T14:01:29.196Z", "changed_at": "2022-08-07T14:01:29.196Z", "remote_deleted_at": null, "remote_data": null, "user": { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32", "first_name": "Sarah", "last_name": "Johnson", "work_email": "sarah.johnson@example.com" }, "course_revision": { "id": "3KMdr68N8kG9EzLwjsN9aoz", "remote_id": "revision-12345", "title": "Building LMS integrations with Kombo", "course": { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32" } } } ] } ] } }, "required": [ "status", "data" ] }