Session deletion endpoint
This endpoint may not be included in your product license. For more information and access, reach out to your Learnosity Account Manager.
Programmatically delete a session and all associated data.
Important Once deleted, the session and its associated data cannot be recovered.
Endpoints:
Usage
The format of requests to the Data API use the following syntax:
https://data.learnosity.com/{LTS_VERSION}/{endpoint}
For example, to use the v2025.1.LTS
version and the itembank/items
endpoint, you would create a request like so:
https://data.learnosity.com/v2025.1.LTS/itembank/items
Important Data API is not a REST API. All requests must use the POST method with the action
request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.
Note Data API usage is subject to rate limits.
Related articles:
- Getting Started with the Data API
- See Release Cadence and Version Lifecycle for more information on available LTS versions.
Session deletion
Delete a session and all associated data. The data removed includes:
- Session-specific data, such as times and scores.
- Responses linked to the session.
- Media files uploaded as part of session responses.
- Session records stored in the data warehouse used for aggregate reporting.
The deletion process is handled as an asynchronous job. You can monitor the job's status by using the GET /jobs endpoint with the returned job_reference
.
Important Once deleted, the session and its associated data cannot be recovered.
Important This endpoint has a rate limit of 5 requests per 5 second window, per API consumer key.
Endpoint | /{LTS_VERSION}/sessions |
---|---|
HTTP method | POST |
Action type | "delete" |
Request body parameters
Body content type: application/json
-
session_ids array[string]
A list of session IDs to be deleted.
Maximum entries:
50
Request body example
{ "session_ids": [ "88336e4c-04de-4274-ae31-39957b230f98" ] }
Responses
Response example
{ "meta": { "status": true, "timestamp": 1433375442 }, "data": [ { "job_reference": "58023cd7-3158-4b47-9708-34f976466cd7" } ] }