Search Page

🔒

Requires write_shop_navigation access scope.

The Get Page By URL API retrieves detailed information about a specific page within a store based on its URL.

This API is especially useful for:

  1. Fetch page details using a target URL as the identifier.
  2. Check SEO optimization status of specific pages.

Request Parameters

Public Request Parameters

📘

Query Parameters

ParameterTypeRequiredDescriptionExample
urlstringNotarget URL as the identifier.’‘

Response Description

Public Response Fields

📘

Success Response

FieldTypeExampleDescription
codestring"success"Status code of the response
messagestringDescriptive message of the response
data.page.idinteger12345Unique ID of the page.
data.page.store_idinteger67890Store ID to which the page belongs.
data.page.titlestringAbout UsThe title of the page.
data.page.updated_atstring2023-10-15T14:30:00ZTimestamp of the last update.
data.page.urlstring/about-usURL of the page.
data.page.meta_keywordsarray["company", "about", "team"]SEO keywords for the page.
data.page.meta_descriptionstringLearn more about our company and team.SEO description of the page.
data.page.independent_seobooleantrueWhether SEO is managed independently.
data.page.originstring

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!