Skip to content

Get hosting usage

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

Returns how many theme previews are running against the store’s limit, and the build time used this calendar month (UTC) in seconds. It does not need a plan that includes Hosting.

Required scopes: deploy:storefront

storeRef
required
string

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

Media typeapplication/json
object
previews
required

Theme previews running now, against the store’s limit.

object
running
required

Theme previews running now.

number
limit
required

How many previews the store may run at once.

number
build_seconds_month
required

Billable build time this calendar month (UTC), in seconds.

number

Example generated

{
"previews": {
"running": 1,
"limit": 1
},
"build_seconds_month": 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"
}

The resource does not exist in this store.

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"
}