Skip to content

Get content page statistics

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

Returns page counters. The counters are not computed yet: every value is currently 0 and by_type is empty.

Required scopes: read:pages

storeRef
required
string

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

Media typeapplication/json
object
by_type
required

Number of pages per page type, keyed by type.

object
key
additional properties
number
total_pages
required

Total number of pages.

number
published_pages
required

Number of published pages.

number
draft_pages
required

Number of draft pages.

number

Example generated

{
"by_type": {
"additionalProperty": 1
},
"total_pages": 1,
"published_pages": 1,
"draft_pages": 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"
}