search_blocks
Scan every page document, including pages with no public route, plus page components and header/footer. Optional filters are AND-ed: blockType, text (literal contains), urlContains, settingPath plus settingValue. Matches only a block's own props, not nested blocks. Each hit includes ancestorIds. settingPath snippets are the matched value. fields returns those prop values and omits snippet. dedupeLocales defaults to true and each hit includes locales. Pass locales to limit the scan. No regex. Returns up to 50 hits, or stops after 12 documents, plus a cursor, per-surface document and hit counts, and skipped. Pass the cursor back to resume. Document counts cover the whole site. Hit counts and skipped cover this response. A null cursor means every document was read. skipped reason is missing or load_failed.
search_blocks · Group: design
Scan every page document, including pages with no public route, plus page components and header/footer. Optional filters are AND-ed: blockType, text (literal contains), urlContains, settingPath plus settingValue. Matches only a block's own props, not nested blocks. Each hit includes ancestorIds. settingPath snippets are the matched value. fields returns those prop values and omits snippet. dedupeLocales defaults to true and each hit includes locales. Pass locales to limit the scan. No regex. Returns up to 50 hits, or stops after 12 documents, plus a cursor, per-surface document and hit counts, and skipped. Pass the cursor back to resume. Document counts cover the whole site. Hit counts and skipped cover this response. A null cursor means every document was read. skipped reason is missing or load_failed.
Inputs
| Field | Required | Notes |
|---|---|---|
websiteId | required | |
blockType | optional | |
text | optional | |
urlContains | optional | |
settingPath | optional | |
settingValue | optional | |
contentLocale | optional | |
locales | optional | Locale codes to scan |
dedupeLocales | optional | Default true |
fields | optional | Prop paths to return |
cursor | optional |
Maps to
POST /api/v1/{locale}/{websiteId}/design/search-blocks→ API