Skip to main content
NICE CXone Expert
Expert Success Center

pages/{pageid}/explain (GET)


Explain how contents of a page are rendered (only meaningful with ?include=contents).

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
pageid string either an integer page ID, "home", or "=" followed by a double uri-encoded page path

Query Parameters

Name Type Description
format {html, xhtml}? Result format (default: html)
revision string? Page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer or a GUID will retrieve specific revision
include string? Extra elements to include (choice of "contents","prevnext"; default: include nothing extra)
includeDeleted bool When pageid is an integer page ID, and this parameter is set to true, we will even return the page if it was deleted at some point
mode {edit, raw, view} render content for different uses; default is 'view'
authenticate bool? Force authentication for request (default: false)
redirects int? If zero, do not follow page redirects.
exclude string? Elements to exclude from response document (choice of "inbound", "outbound", "files"; default: exclude nothing)

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 Read access to the page is required
Not Found 404 Requested page could not be found


  • Was this article helpful?