> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Method name:

siteSite.getSiteStructure()

# Method Link:

https://dev.wix.com/docs/frontend-modules/frontend-modules/site/get-site-structure.md

# Method Description:

Returns information about a site's pages, prefixes, and popups.

The returned `SiteStructure` object is a flattened representation of a site.
 The structure doesn't include the headers and links from a site's **Pages** menu.

# Method Permissions:



# Method Permissions Scopes IDs:

undefined



# Method Code Examples:

## Get information about the site's pages, prefixes, and popups (lightboxes)

```javascript
import { site } from '@wix/site-site';

// ...

const structure = await site.getSiteStructure();

/*
*  {
*    "pages": [
*      {
*        "name": "Home",
*        "type": "static",
*        "url": "/home",
*        "isHomePage": true
*      },
*      {
*        "name": "Page 1",
*        "type": "static",
*        "url:" /page-1"
*      },
*      {
*        "name": "Page 2",
*        "type": "static",
*        "url": "/page-2"
*      },
*      {
*        "name": "Parent Page",
*        "type": "static",
*        "url": "/parent-page"
*      },
*      {
*        "name": "Child Page",
*        "type": "static",
*        "url": "/child-page"
*      },
*      {
*        "name": "router-page",
*        "type": "template",
*        "prefix": "router"
*      },
*      {
*        "name": "MyCollection (Title)",
*        "type": "template",
*        "prefix": "MyCollection"
*      },
*      {
*        "name": "MyCollection (All)",
*        "type": "template",
*        "prefix": "MyCollection"
*      },
*      {
*        "name": "Dashboard Page",
*        "type": "static"
*      },
*      {
*        "name": "Shop",
*        "type": "template",
*        "url": "/shop",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Product Page",
*        "type": "template",
*        "url": "/product-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Thank You Page",
*        "type": "template",
*        "url": "/thank-you-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Cart",
*        "type": "template",
*        "url": "/cart",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Members",
*        "type": "template",
*        "url": "/members",
*        "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
*      }
*    ],
*    "prefixes": [
*      {
*        "name": "router",
*        "type": "router",
*        "prefix": "/router"
*      },
*      {
*        "name": "MyCollection",
*        "type": "dynamicPages",
*        "prefix": "/MyCollection"
*      },
*      {
*        "name": "MyCollection",
*        "type": "dynamicPages",
*        "prefix": "/MyCollection"
*      },
*      {
*        "name": "Shop",
*        "type": "app",
*        "prefix: "/shop",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Product Page",
*        "type": "app",
*        "prefix": "/product-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Thank You Page",
*        "type": "app",
*        "prefix": "/thank-you-page",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Cart",
*        "type": "app",
*        "url": "/cart",
*        "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
*      },
*      {
*        "name": "Members",
*        "type": "app",
*        "prefix": "/members",
*        "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
*      }
*    ],
*    "lightboxes": [
*      {
*        "name": "Welcome (Full Screen)"
*      }
*    ]
*  }
*/

```