Get Page Count

Retrieve the total number of pages.

🔒

Requires read_shop_navigation access scope. More access scope

The Count Page API retrieves the total number of pages that match optional filter criteria.

This API is especially useful for:

  1. Displaying the total count of pages in administrative dashboards or analytics.

Request Parameters

Public Request Parameters

📘

Query Parameters

ParameterTypeRequiredDescriptionExample
titlestringNoThe title of the page to filter by."About Us"

If the title parameter is not provided or left empty, the API returns the total count of all pages in the store.

Response Explanation

Public Response Parameters

📘

Successful Response

FieldTypeDescriptionExample
codestring"success"Status code of the response
messagestringDescriptive message of the response
data.countintTotal number of pages matching the query.2

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!