Tag Hierarchies endpoint

Manage your Tag Hierarchies.

See How Do Tag Hierarchies Work? for more information.

Endpoints:

• Get Tag Hierarchies
• Get Tag Hierarchy Nodes

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.

Retreives the hierarchy of Tag types for the specified hierarchy references.

You would want to use this to retrieve specific Tag hierarchies for use in your own application, for example.

Note Each returned Tag type represents one level of the hierarchy. Each Tag within a level is considered as a "node".

See How Do Tag Hierarchies Work? for more information.

Request body parameters

Body content type: application/json

• organisation_id integer

  Specifies the Item bank to retrieve Tag Hierarchies from.

  The API consumer making the request will need to have access to the Item bank. This access can be checked via the API consumers configuration in the Learnosity Console.

  Default: the primary Item bank associated with the API consumer.

• references array[string]

  A list of hierarchy references to retrieve.

Request body example

{
    "references": ["TagHierarchyTest"]
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1490241998,
        "records": 1
    },
    "data": [
        {
            "reference": "TagHierarchyTest",
            "tag_types": [
                {
                    "name": "author",
                    "description": null
                },
                {
                    "name": "subject",
                    "description": null
                },
                {
                    "name": "course",
                    "description": null
                },
                {
                    "name": "questiontype",
                    "description": null
                }
            ]
        }
    ]
}

Retrieves the next node in a Tag hierarchy from your Item bank.

You would want to use this to retrieve specific Tag hierarchy nodes for use in your own application, for example.

See How Do Tag Hierarchies Work? for more information.

Request body parameters

Body content type: application/json

• organisation_id integer

  Specifies the Item bank to retrieve the Tag hierarchy nodes from.

  The API consumer making the request will need to have access to the Item bank. This access can be checked via the API consumers configuration in the Learnosity Console.

  Default: the primary Item bank associated with the API consumer.

• path array[TagsV2]

  An ordered array of TagsV2 objects.

• reference string

  The reference of the Tag hierarchy to get nodes for.

Request body example

{
    "reference": "TagHierarchyTest",
    "path": [
      { "type": "author",   "name": "J.D. Salinger" },
      { "type": "subject",  "name": "English" }
    ]
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1482285520,
        "records": 2
    },
    "data": [
        {
            "type": "course",
            "name": "commoncore",
            "description": "Common Core"
        },
        {
            "type": "course",
            "name": "example course",
        }
    [
}