get https://{shopdomain}.myshoplaza.com/openapi/2022-01/pages/count
Requires
read_shop_navigationaccess scope. More access scope
The Count Page API allows users to get count of pages by the title.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
title | string | The title of the page to filter by. | No | "About Us" |
If the
titleparameter 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
| Field | Type | Description | Example |
|---|---|---|---|
count | int | Total number of pages matching the query. | 2 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 500 | Internal Server Error | Missing the request file | "file number error" |