The Site API provides information about a site's core configuration, structure, and regional settings. You can use this API to retrieve essential details such as the site’s display name, currency, language, and timezone, as well as information about the site’s pages and routing.
With the Site API you can:
- Access site-level settings like language, currency, timezone, and regional preferences
- Retrieve the site structure, current page, and site display name
- Improve performance by prefetching page resources
- Get the router sitemap for dynamic routing and SEO support
- Currency code: A short code (for example,
USD, EUR) representing the site's configured currency, as set in the site's Dashboard.
- Regional settings: Settings that define how numbers, dates, and currencies are formatted on the site, based on regional preferences.
- Site structure: A flattened representation of all site pages and lightboxes (excluding menu structure), useful for navigation and routing logic.
- Prefetching: The process of loading page or lightbox resources in advance to improve performance during navigation.
- Router sitemap: A list of pages generated from a router or dynamic prefix, used to help search engines index dynamic content.