Navigation menu - field descriptions

This section details the content in the JSON response for a navigation menu, including an example of a JSON response file.

Field	Type	Description
`id`	String	Navigation menu’s unique ID
`title`	String	Title of the menu - intended solely for Cortex administrator clarity
`description`	String	Description of the menu - intended solely for Cortex administrator clarity
`children`	Array	Menu items (see the child object table, below)
`sponsors`	Array	Main menu sponsor comprising three fields: an image URL, a sponsor URL link, and a text field. All are optional, although there must always be one of either the text field or image URL.

Navigation menu - child object field descriptions

Menu items are composed of the following fields:

Field	Type	Description
`id`	String	Navigation menu item’s unique ID
`label`	String	Title of the menu
`link`	String	Link, can be a relative link, such as /tickets or a full external URL. This is an optional field, omitted or ‘null’ if not populated.
`openInTab`	Boolean	Specifies whether the link should open in a new tab or not. Defaults to false
`feedId`	String	Feed builder ID
`pcbId`	String	Promo asset ID
`image`	Content	Image object comprising five fields for: description, image URL, thumbnail URL, link URL, title and alt text. This is an optional field, omitted or `null` if not populated.
`children`	Array	Further nested child menu items of this menu. This is an optional field, omitted or `null` if not populated.
`sponsors`	Array	Child menu sponsor comprising three fields: an image URL, a sponsor URL link, and a text field. All are optional, although there must always be one of either the text field or image URL.

Example JSON response

The JSON for a navigation menu with one menu item is depicted in the JSON code snippet below. The fields are explained above.

Note this is a generalised representation of a JSON response, edited for clarity and demonstration purposes. It is not a real world example.

{
  "data":{
    "children":[
      {
        "children":[
          {
            "children":[ ],
            "id":"2842af3d-9aaf-4abf-ac61-def51b968723",
            "label":"Sub-item label",
            "image":{
              "imageUrl":"https://imageurl.com/item-image.jpg",
              "title":"Image title"
            },
            "link":"primary-item/sub-item",
            "openInTab":false
          }
          ],
        "id":"aa58ce7a-b501-4645-a90a-2e32858283d8",
        "label":"Primary item label",
        "link":"/primary-item",
        "openInTab":true,
        "sponsors":[
          {
            "imageUrl":"https://imageurl.com/itemsponsor.jpg",
            "linkUrl":"http://www.TakeFantoHere.com/itemsponsor",
            "text":"Item sponsor text"
          }
        ]
      }
    ],
    "id":"123456789",
    "title":"Navigation Menu",
    "description":"This controls the navigation of the main site",
    "sponsors":[
      {
        "imageUrl":"https://imageurl./overall-sponsor.jpg",
        "linkUrl":"http://www.takeFanToHere.com",
        "text":"Overall sponsor text"
      }
    ]
  }
}