Documentation Center

Parameters for the typedPage root query

The typedPage root query lets you fetch a Page and explore its type (corresponding to its Page Schema in Content Manager) as well as its Regions.

The root query has the following structure:
typedPage(
    namespaceId: Int
    publicationId: Int
    pageId: Int
    url: String
    cmUri: String
    contextData: [InputClaimValue]
): PageItem

Most importantly, the typedPage query allows you, if you know the Page Schema underlying it, to explore the fields of that Page Schema.

The following example query demonstrates a call to typedPage, which the implementer knows is based on the SimplePage Page Schema:
typedPage(namespaceId:1, publicationId: 5, pageId:371) {       
  ...on SimplePage {
    metadata {
      stringMetadataFieldInSimplePageSchema
    }
  }
  
  regions {
    name
    ...on StmRegionWithChildRegions {
      regions(filter:"ChildRegion") {
        name
      }
    }
  }
}

The call first fetches the Page based on its namespace, the ID of its Publication, and its own ID. It then fetches the value of a metadata field specific to the SimplePage Page Schema, as well as the names of the Regions and the names of its child Region called ChildRegion, on the Page.

Within a typedPage call, just like within a page call, you can also explore any Regions that the Page contains with the regions subquery.