suo
Concepts

Hierarchy records (lvl0–lvl6)

The DocSearch-style record shape that lets results group by page with a breadcrumb.

When suo crawls a page, or when you push content shaped like a page, it splits the page into records along its headings and stores each one's place in that structure as hierarchy, with up to seven levels, lvl0 through lvl6.

{
	"objectID": "docs-guides-crawl-a-docs-site-include-and-exclude-paths",
	"url": "https://docs.example.com/guides/crawl-a-docs-site#include-and-exclude-paths",
	"anchor": "include-and-exclude-paths",
	"type": "content",
	"lang": "en",
	"hierarchy": {
		"lvl0": "Guides",
		"lvl1": "Crawl a docs site",
		"lvl2": "Include and exclude paths"
	},
	"content": "By default the crawler follows every path under the domain you verified…"
}
  • lvl0 is usually a section or category (a sidebar group).
  • lvl1 is the page title.
  • lvl2–lvl6 are nested headings on the page, in order.
  • type marks whether the record is the page itself (page), a heading section (section) or a paragraph of body content under a heading (content).

Why this shape

A search result is not one giant page; it is the most relevant section of a page. Grouping results by their shared lvl0/lvl1 and showing the breadcrumb above the match (Guides › Crawl a docs site › Include and exclude paths) tells a reader exactly where a hit sits before they click it — this is the pattern DocSearch popularized, and the widget's grouped result view expects it.

Ranking weight

hierarchy.lvl0 and lvl1 sit in the highest searchable tier alongside title; deeper levels and content sit lower. A query matching a page title ranks above the same query matching a sentence buried in the body — see Index-time vs query-time settings and The ranking cascade.

Pushing your own hierarchy records

You do not need a crawl to use this shape. If you push app content that reads like documentation — a help center, a changelog — give your records the same hierarchy fields and suo will group and rank them the same way. See Push app content.

On this page