Skip to content

Get search index status

GET
/stores/{storeRef}/search/index-status
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/search/index-status \
--header 'x-api-key: <x-api-key>'

Returns how many of the store’s products and blog posts are still waiting to reach the search index. A change shows up in search and in collections once pending is 0, so poll this after a bulk write.

Required scopes: read:products

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
pending
required

Products and blog posts still waiting to reach the search index. 0 means every saved change is searchable.

number

Example generated

{
"pending": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}