Learnosity

https://help.learnosity.com/hc/en-us/
Admin
Learnosity is an educational technology platform providing assessment APIs, AI-powered authoring...
Tokens:2,521,191
Snippets:39,242
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Execute a Data API request in PHP

Source: https://help.learnosity.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCG2jt9FTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCFaYt9FTADoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJGL2hjL2VuLXVzL2FydGljbGVzLzM2MDAwMDc1ODYzNy1HZXR0aW5nLVN0YXJ0ZWQtV2l0aC10aGUtRGF0YS1BUEkGOwhUOglyYW5raQg%3D--9d8cc0b8a4a8b532e1639389f11218f13cae4dea

This example demonstrates how to initialize the Data API, configure security credentials, and perform a 'get' request to retrieve session responses. Ensure the Learnosity SDK is installed and your configuration file is correctly referenced.

```php
<?php  
  
// Copyright (c) 2023 Learnosity, MIT License  
// Basic example code for pulling information from the Learnosity cloud   
// using Data API.  
  
// Setup block, to load the necessary classes from the example directory,   
// and set up variables for access.  
require_once __DIR__ . '/../../../bootstrap.php';  
  
// Load security keys from local file config.php, for Learnosity's public demos account.  
$config = require_once __DIR__ . '/../config.php';   
  
// Load core Data API library.  
use LearnositySdk\Request\DataApi;   
  
// Choosing the Data API endpoint for sessions/responses.  
$itembank_uri = 'https://data.learnosity.com/v2023.1.LTS/sessions/responses';   
  
// Selecting the Learnosity account (consumer key).  
$consumerKey = $config['consumerKey'];   
// Note: Learnosity will provide keys for your own private account.  
  
$security_packet = [  
// Selecting the Learnosity account (consumer key).  
	   'consumer_key' 	   => $consumerKey,   
  
// Selecting the domain where your app will be resident  
// ('localhost' is for testing local code).   
 	  'domain' 		   => 'localhost',	   
];  
  
// Providing the password for the Learnosity account from the configuration file.  
$consumer_secret = $config['consumerSecret'];   
  
// Essential step of initializing the API  
$data_api = new DataApi();   
  
// Request setup block. Creates a variable holding the Data API request options as JSON.  
$data_request = [  
 	  'user_id' => ['student_0001'],  
 	  'mintime' => '2020-01-01',  
 	  'maxtime' => '2020-12-31',  
 	  'limit' => 1  
];  
  
// Result setup block. Compiles all of the security configuration   
// and request options together, then calls Data API to get the data.   
$result = $data_api->request(  
 	  $itembank_uri,  
 	  $security_packet,  
 	  $consumer_secret,  
 	  $data_request,  
 	  'get'  
);  
  
// Printout block. Printing the output into the browser window.  
// Convert the request data to JSON format.  
$response = $result->json();   
  
// Get the HTTP status code that the request returned, and add it to the data.  
echo "<<< [{$result->getStatusCode()}]" . PHP_EOL;   
  
// Print the returned data into the browser window.  
print_r($result->getBody());   
// Note, you can also use getJson() in the line above to return more easily   
// manipulated data.
```

--------------------------------

### PHP Server Output Example

Source: https://help.learnosity.com/hc/en-us/articles/360000757757-Environment-Setup-Guide-PHP

Expected console output when starting the PHP development server.

```text
lrn$ php -S localhost:8000
PHP 8.x Development Server started at $date, $time
Listening on http://localhost:8000
Document root is ~/Public/www
Press Ctrl-C to quit.
```

--------------------------------

### begin()

Source: https://help.learnosity.com/hc/en-us/articles/16760657896477-begin-Methods-Questions-API

Starts the Questions API feature. This method takes no arguments and returns undefined.

```APIDOC
## begin()

### Description
Starts the Questions API feature.

### Arguments
None.

### Return Value
None (undefined).
```

--------------------------------

### Example Academic Benchmarks GUID Tag

Source: https://help.learnosity.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCO3hB9JTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCB28xMVTDzoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJpL2hjL2VuLXVzL2FydGljbGVzLzM2MDAwNjAxNzUxNy1MZWFybm9zaXR5LWludGVncmF0aW9uLXdpdGgtQWNhZGVtaWMtQmVuY2htYXJrcy1zdGFuZGFyZHMtdXNpbmctVGFncwY7CFQ6CXJhbmtpCg%3D%3D--adf7d2829e0e8a01b2c4ae0a208b379ee118e45d

An example of a Learnosity Tag structure where lrn_ab_aligned is the reserved Tag type and the GUID is the Tag name.

```text
**lrn_ab_aligned****: F1FA078C-3B53-11E0-B042-495E9DFF4B22**
```

--------------------------------

### begin()

Source: https://help.learnosity.com/hc/en-us/articles/16760622112669-begin-Methods-Questions-API

Triggers the audio or video question instance to begin recording.

```APIDOC
## begin()

### Description
Triggers the `audio` or `video` question instance to begin recording.

### Arguments
None.

### Return value
None (`undefined`).
```

--------------------------------

### start()

Source: https://help.learnosity.com/hc/en-us/articles/16735132587421-start-Methods-Assess-API

Launches the test when it is ready. This method is used when an intro_item has been configured to programmatically start the activity.

```APIDOC
## start()

### Description
Launches the test when it is ready. This method is used when an intro_item has been configured to programmatically start the activity.

### Arguments
None.

### Return value
None (undefined).
```

--------------------------------

### Get Jobs Response Example

Source: https://help.learnosity.com/hc/en-us/articles/26076318439197-Jobs-Endpoints-Data-API

Example JSON response containing job status and metadata.

```json
{
    "meta":{
        "status":true,
        "timestamp":1389192595
        "records": 1
    },
    "data": [
        {
            "reference": "9fd443d0-2b4f-4315-aec6-708da3d30d49",
            "type": "manualresponseupdate",
            "status": "completed",
            "dt_created": "2015-04-24 01:30:02",
            "dt_completed": "2015-04-24 01:30:03"
        }
    ]
}
```

--------------------------------

### Initialize Dataset Request Example

Source: https://help.learnosity.com/hc/en-us/articles/360000755898

A concrete example of a request URL targeting the 2023.3.LTS version.

```text
https://data.learnosity.com/v2023.3.LTS/reports/datasets
```

--------------------------------

### Get Tags Response Example

Source: https://help.learnosity.com/hc/en-us/articles/26076379042589-Tags-Endpoints-Data-API

Example JSON response structure for a successful tag retrieval request.

```json
{
    "meta": {
        "status": true,
        "timestamp": 1389193100
    },
    "data": {
        "subject": [
            "English",
            "Maths"
        ]
    }
}
```

--------------------------------

### Run development server

Source: https://help.learnosity.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBEhjMwDBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCA3zt9JTADoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJYL2hjL2VuLXVzL2FydGljbGVzLzQ0MTQzNjMxNDg1NjEtR2V0dGluZy1TdGFydGVkLXdpdGgtQ3VzdG9tLVF1ZXN0aW9ucy1hbmQtRmVhdHVyZXMGOwhUOglyYW5raQk%3D--c751bb31e722585a854bd6c36b046a2107eaa41d

Starts the local development environment for testing custom questions.

```bash
yarn dev
```

--------------------------------

### Get Tags Response Example

Source: https://help.learnosity.com/hc/en-us/articles/26076379042589-Tags-Endpoints-Data-API

Example JSON response containing tag data and pagination metadata.

```json
{
    "meta": {
        "status": true,
        "timestamp": 1389193100,
        "records": 2,
        "next": "138919500.781"
    },
    "data": [
        {
            "type": "course",
            "name": "Math",
            "description": "Elementary math"
        },
        {
            "type": "course",
            "name": "English",
            "description": "English reading, writing, literature"
        }
    ]
}
```

--------------------------------

### Get Pools Response Example

Source: https://help.learnosity.com/hc/en-us/articles/26076363663005-Pools-Endpoints-Data-API

Example JSON response structure returned when querying Item pools.

```json
{
    "meta": {
        "status": true,
        "timestamp": 1389193100,
        "records": 1
    },
    "data": {
        "reference": "ela-district-a",
        "description": "Content pool for ELA District A",
        "name": "ELA 2015 District A",
        "status": "published",
        "dt_created": 2015-01-08T07:34:00Z,
        "dt_updated": 2015-01-08T07:34:00Z
    }
}
```

--------------------------------

### Install Python dependencies

Source: https://help.learnosity.com/hc/en-us/articles/19959510568605-Feedback-Aide-Security-Tokens

Commands to set up a virtual environment and install the necessary OAuth libraries.

```bash
python -m venv oauthenv
source oauthenv/bin/activate
pip install requests requests-oauthlib
```

--------------------------------

### Get Tags Request Body Example

Source: https://help.learnosity.com/hc/en-us/articles/26076379042589-Tags-Endpoints-Data-API

Example JSON payload for retrieving specific tags by type and name.

```json
{
    "types": ["course", "subject"],
    "tags": ["English", "Maths"],
}
```

--------------------------------

### LearnosityFeedbackAide.init()

Source: https://help.learnosity.com/hc/en-us/articles/19278799977885-Getting-Started-with-Feedback-Aide-API

Initializes the Feedback Aide library and returns an instance of the application.

```APIDOC
## LearnosityFeedbackAide.init()

### Description
Creates an instance of the Feedback Aide application.

### Method
JavaScript Method

### Signature
`await LearnosityFeedbackAide.init()`
```

--------------------------------

### LearnosityFeedbackAide.init()

Source: https://help.learnosity.com/hc/en-us/articles/23066694443421-Advanced-Feedback-Aide-Headless-Mode

Initializes the Feedback Aide library and returns an instance of the application.

```APIDOC
## LearnosityFeedbackAide.init()

### Description
Initializes the Feedback Aide library in the JavaScript runtime.

### Usage
```javascript
const feedbackApp = await LearnosityFeedbackAide.init();
```
```

--------------------------------

### Get Jobs Request Body Example

Source: https://help.learnosity.com/hc/en-us/articles/26076318439197-Jobs-Endpoints-Data-API

Example JSON body for retrieving specific job information by reference.

```json
{
    "references": [
        "9fd443d0-2b4f-4315-aec6-708da3d30d49"
    ]
}
```

--------------------------------

### Initialize React Native Project

Source: https://help.learnosity.com/hc/en-us/articles/360018182058-Build-a-Local-Device-Assessment-application-in-React-Native-with-Learnosity-Assessment-APIs

Create a new project using the bare-minimum Expo template.

```bash
expo init --template bare-minimum
```

--------------------------------

### GET Item pool information request

Source: https://help.learnosity.com/hc/en-us/articles/360000755878-Using-Item-Pools-to-Create-Content-Snapshots

Example of a GET request to the itembank/pools endpoint to retrieve item pool details.

```json
// The Data API request endpoint for this example is 'itembank/pools'
// The request type is GET

{
    "references": ["example_itempool_reference"],
    "status": ["published"]
}
```

--------------------------------

### Get Tags Request Body Example

Source: https://help.learnosity.com/hc/en-us/articles/26076379042589-Tags-Endpoints-Data-API

Example JSON payload for retrieving specific tags with filtering and sorting parameters.

```json
{
    "types": [
        "course",
        "subject"
    ],
    "names": [
        "Math",
        "Advanced Math",
        "English"
    ],
    "sort_field": "updated",
    "limit": 2
}
```

--------------------------------

### window.LearnosityApp.init()

Source: https://help.learnosity.com/hc/en-us/articles/16458107750301-request-Questions-API

Initializes the Learnosity Questions API with the provided configuration object.

```APIDOC
## window.LearnosityApp.init(initializationObject)

### Description
Initializes the Learnosity Questions API. The initialization object contains authentication credentials, user identification, and configuration for questions, features, and UI elements.

### Parameters
- **initializationObject** (object) - Required - The configuration object containing the following properties:
  - **consumer_key** (string) - Required - Provided by Learnosity.
  - **signature** (string) - Required - HMAC SHA256 hash of parameters and consumer_secret.
  - **timestamp** (string) - Required - Current time in YYYYMMDD-HHMM format.
  - **user_id** (string) - Required - Unique user identifier.
  - **id** (string) - Required - Activity ID.
  - **session_id** (UUIDv4) - Required - Reference to the user's assessment attempt.
  - **questions** (array[QuestionJson]) - Optional - List of Question objects.
  - **features** (array[FeatureJson]) - Optional - List of Feature objects.
  - **renderSaveButton** (boolean) - Optional - Whether to render a save button.
  - **renderSubmitButton** (boolean) - Optional - Whether to render a submit button.
  - **state** (string) - Optional - Sets the activity state.
  - **type** (string) - Optional - Defines saving/submitting behavior.
  - **fontsize** (string) - Optional - Font size for rendering.
  - **showCorrectAnswers** (boolean) - Optional - Controls display of correct answers.
  - **attribute_overrides** (object) - Optional - Activity level overrides.
  - **custom_widget_options** (object) - Optional - Configuration for third-party widgets.
  - **labelBundle** (object) - Optional - Overrides for labels and text content.
  - **render_optimization** (object) - Optional - Rendering performance options.
  - **show_distractor_rationale** (boolean|object) - Optional - Distractor rationale display options.
  - **allow_negative_scores** (boolean) - Optional - Enables negative scoring.
  - **captureOnResumeError** (boolean) - Optional - Triggers error if response_id is missing on resume.
  - **disable_auto_link** (boolean) - Optional - Disables auto-linking of URLs.
  - **disable_spokenmath_user_inputs** (boolean) - Optional - Disables spokenmath in user input.
  - **disable_spokenmath_distractors** (boolean) - Optional - Disables spokenmath in distractors.
  - **enable_formula_keyboard_lazy_render** (boolean) - Optional - Enables lazy rendering for math keyboards.
  - **math_renderer** (string) - Optional - Overwrites math_renderer option.
  - **mirror_visibility** (boolean) - Optional - Mirrors visibility of floating elements.
  - **name** (string) - Optional - Activity name.
  - **question_source** (string) - Optional - Source for rendering questions.
  - **showInstructorStimulus** (boolean) - Optional - Shows instructor stimulus content.
  - **skip_replay_animation** (boolean) - Optional - Skips replay animations.
  - **validateOnSubmit** (boolean) - Optional - Enables instant feedback on submit.
```

--------------------------------

### Get Pools Request Body Example

Source: https://help.learnosity.com/hc/en-us/articles/26076363663005-Pools-Endpoints-Data-API

Example JSON request body for retrieving specific Item pools by reference.

```json
{
    "references": ["ela-district-a"]
}
```

--------------------------------

### Author API init() Usage Variants

Source: https://help.learnosity.com/hc/en-us/articles/16782372531101-init-Methods-Author-API

Examples demonstrating different ways to call init() with or without callbacks and custom DOM selectors.

```html
<!-- Example 1: On the page, add a <div> container with a unique ID where the authoring interface will be rendered, pass to init() along with a `callbacksObject` -->
<div id="my-authoring-interface-container"></div>

<script>
    // When init() is called, the authoring interface will be injected
    // into the container with ID 'my-authoring-interface-container' on the page
    window.LearnosityAuthor.init(
        initializationObject,
        callbacksObject,
        '#my-authoring-interface-container'
    );
</script>
```

```html
<!-- Example 2: On the page, add a <div> container with a unique ID where the authoring interface will be rendered, pass to init() but omit `callbacksObject` if it's not required -->
<div id="my-authoring-interface-container"></div>

<script>
    window.LearnosityAuthor.init(
        initializationObject,
        '#my-authoring-interface-container'
    );
</script>
```

```html
<!-- Example 3: On the page, add a <div> container with the default ID (so no need to pass `domSelector` to init()) -->
<div id="learnosity-author"></div>

<script>
    // When init() is called, the authoring interface will be injected
    // into the container with ID 'learnosity-author' on the page
    // Note no string (nor callbacks) are passed here.
    window.LearnosityAuthor.init(
        initializationObject
    );
</script>
```

--------------------------------

### Get Statuses Request Body Example

Source: https://help.learnosity.com/hc/en-us/articles/26076351111453-Statuses-Endpoints-Data-API

Example request body for retrieving specific session IDs with additional metadata.

```json
{
    "session_id": [
        "0a643076-1161-4aef-bf59-a5126a72a403",
        "15658ed8-c334-4697-a860-6f1997ac19f8",
        "c67687d8-cd2a-41e1-a3a3-769f334833b1"
    ],
    "include": {
        "sessions": [ "activity_template_id" ]
    }
}
```

--------------------------------

### window.LearnosityApp.init()

Source: https://help.learnosity.com/hc/en-us/articles/16458097213981-initialization-Questions-API

Initializes and renders the Questions API. This method requires an initialization object containing security credentials and activity configuration, and optionally accepts a callbacks object for event handling.

```APIDOC
## window.LearnosityApp.init(initializationObject, callbacks)

### Description
Initializes the Questions API. This is the entry point for rendering questions and managing the assessment session.

### Parameters
- **initializationObject** (Object) - Required - Contains security credentials (consumer_key, signature, timestamp, user_id), activity configuration (id, name, questions), and optional behavior overrides.
- **callbacks** (Object) - Optional - Contains event listeners such as errorListener, readyListener, saveSuccess, saveError, and saveProgress, as well as labelBundle configurations.

### Request Example
```javascript
const initializationObject = {
    "consumer_key" : "ts34Rdc45SWE34f",
    "signature": "22d26b3b582d5bca19b26784534b338381a0ac1bc737b071a971c5b7d0cf9721",
    "timestamp": "20110918-1820",
    "user_id": "aeee19fb-4e7b-435c-92f9-d93a1099988b",
    "id": "f0001",
    "name": "Intro Activity - French 101",
    "questions": [...],
    "session_id" : "f47ac10b-58cc-4372-a567-0e02b2c3d479"
};

const callbacks = {
    readyListener: function() {
        console.log("Learnosity Questions API is ready");
    }
};

const questionsApp = window.LearnosityApp.init(initializationObject, callbacks);
```
```

--------------------------------

### Get Session Response Score Grading Response Example

Source: https://help.learnosity.com/hc/en-us/articles/37621876726813-Session-Response-Score-Grading-Endpoints-Data-API

Example JSON response containing manual grading scores for a specific session.

```json
{
    "meta": {
        "status": true,
        "timestamp": 1744349597
    },
    "data": [
        {
            "session_id": "30f62430-5dfa-48eb-bacd-c898d5bdf682",
            "items": [
                {
                    "item_reference": "f2175579-3544-47f5-bcdb-73f216798471",
                    "responses": [
                        {
                            "response_id": "30f62430-5dfa-48eb-bacd-c898d5bdf682_4747e121c5af5f53e3a517a76025e281",
                            "graders": [
                                {
                                    "grader_id": "grader1234",
                                    "score": 8,
                                    "max_score": 10,
                                    "is_reference": true,
                                    "source": "lrn_manual_grading",
                                    "time_created": "2026-07-06 00:50:03.395242+00",
                                    "time_updated": "2026-07-06 00:50:03.395242+00"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
```
Tokens:
Raw