List navigation trees

GET /navigation/trees
Api key

Returns the list of navigation trees available to your corporation.

A navigation tree is a tree-structure to organize your products and navigate into them in a classic "nested folders" architecture.

Responses

  • 200 application/json

    Successfully returned available navigation trees

    Hide response attributes Show response attributes object
    • status string
    • result object

      Additional properties are allowed.

      Hide result attribute Show result attribute object
      • navigation_trees array[object]
        Hide navigation_trees attributes Show navigation_trees attributes object
        • id string

          The unique id of the navigation tree

        • key string

          A key identifying the navigation tree, for understanding purpose, not guaranteed unique

        • allow_multiple_nodes boolean

          Whether or not a product can be located in multiple nodes of the tree

        • api_get_navigation_tree url

          The API endpoint to get the content of this navigation tree
GET /navigation/trees 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/navigation/trees \
 -H "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "navigation_trees": [
      {
        "id": "aada9924-34dd-4ce7-8e15-482ff0c8fa81",
        "key": "by-risk",
        "allow_multiple_nodes": false,
        "api_get_navigation_tree": "/api/v1/navigation/trees/aada9924-34dd-4ce7-8e15-482ff0c8fa81"
      },
      {
        "id": "b1702cb8-b68e-47e5-a8fe-4a1b330d567f",
        "key": "website-tree-structure",
        "allow_multiple_nodes": true,
        "api_get_navigation_tree": "/api/v1/navigation/trees/b1702cb8-b68e-47e5-a8fe-4a1b330d567f"
      }
    ]
  }
}