ANanzworldline-solutions
Page

Get rendered page metadata by URI

Changed on

Returns the metadata of an HTML Page including its rendered HTML code and container content in JSON format based on the specified URI. If the URI maps to a Vanity URL, a 200 Forward returns the actual rendered page, while a 301/302 redirect returns an empty page JSON with Vanity URL properties. Supports Time Machine via the publishDate parameter (ISO 8601 format). For EMA (Enterprise Marketing Automation) requests, this may delegate to the JSON endpoint when the rendered attribute is not required.

The URI must be a plain page path (no embedded host). To render a page on a NON-default site, pass the host_id query parameter (backend users only); without it the current/default site is used. The //host/uri path form is NOT supported.

get/api/v1/page/render/{uri}

Request

Path parameters

uristring required

Path to the HTML Page or Vanity URL (e.g., 'about-us/locations/index'). Must be a plain path with no embedded host; use host_id to target a specific site.

Query parameters

host_idstring

Explicit site to render against, given as a host identifier (UUID). Backend users only; if omitted the current/default site is used.

modestring

Page mode for rendering (e.g., EDIT_MODE, PREVIEW_MODE, LIVE)

com.dotmarketing.persona.idstring

Persona identifier to render the page with personalization

language_idstring

Language ID for the page content

device_inodestring

Device inode for responsive rendering dimensions

publishDatestring

Time Machine date in ISO 8601 format to view page as it was at a specific point in time

Response

Rendered page retrieved successfully

i18nMessagesMapobject
permissionsstring[]

Changes

  • 4fd8e917d458Revision changes
    • breaking

      added the pattern .* to the path request parameter uri

    • info

      api operation id render removed and replaced with getPageRenderByUri

    • info

      added the new optional query request parameter host_id

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status