A valid request URL is required to generate request examples{
"serving": true,
"stage": "not_started",
"lite": {
"read": "ok",
"ingestionState": 123,
"running": true,
"finalizing": true,
"workflowId": "<string>",
"startedAt": "<string>",
"registeredBatches": 123
},
"foundation": {
"read": "ok",
"s2Active": true,
"s3Active": true,
"pendingRerun": true,
"backlog": true,
"lastProjectedAt": "<string>"
},
"index": {
"expectedDocuments": 123,
"indexedDocuments": 123,
"locales": [
{
"code": "<string>",
"aliasPresent": true,
"documents": 123
}
]
},
"checkedAt": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Where a merchant's catalog is between Shopify and the search index
Returns where the merchant’s catalog is between Shopify and the search/recommendations index: the pipeline stage, whether search is serving, and document counts. Call it to tell whether search and recommendations can work yet, or how far an import has come; the portal polls it every few seconds while a store activates. Read-only.
A valid request URL is required to generate request examples{
"serving": true,
"stage": "not_started",
"lite": {
"read": "ok",
"ingestionState": 123,
"running": true,
"finalizing": true,
"workflowId": "<string>",
"startedAt": "<string>",
"registeredBatches": 123
},
"foundation": {
"read": "ok",
"s2Active": true,
"s3Active": true,
"pendingRerun": true,
"backlog": true,
"lastProjectedAt": "<string>"
},
"index": {
"expectedDocuments": 123,
"indexedDocuments": 123,
"locales": [
{
"code": "<string>",
"aliasPresent": true,
"documents": 123
}
]
},
"checkedAt": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Path Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The readiness snapshot.
Every locale's serving index exists and holds documents; null while a count is unreadable.
Pipeline position; ready = fully indexed, stalled = no progress where some was expected.
not_started, fetching_shopify, finalizing, projecting, indexing, ready, stalled, unknown Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?