Page Tools

Page tools manage the pages (tabs/sheets/canvases) of a report asset in the session.

---

get_pages

Returns all pages in the session's OpenBI asset, ordered by Order.

Parameters

Name	Type	Required	Description
session_id	string	✅	Session id from create_session

Response

{
  "pages": [
    {
      "id": "page-001",
      "friendlyName": "Overview",
      "order": 1,
      "width": 1280,
      "height": 720,
      "isEnabled": true,
      "description": null
    }
  ]
}

---

get_page

Returns a single page by ID, including its visuals and page-level filters.

Parameters

Name	Type	Required	Description
session_id	string	✅	Session id from create_session
page_id	string	✅	Page id from get_pages

Response

Full Page object with visuals and pageLevelFilters arrays populated.

---

create_page

Creates a new page in a session asset. Returns the generated page id.

Parameters

Name	Type	Required	Description
session_id	string	✅	Session id from create_session
assetId	string	✅	Asset id from list_assets
friendly_name	string	✅	Display name of the page/tab
order	int	✅	Tab position (integer)
width	decimal	✅	Canvas width in platform units
height	decimal	✅	Canvas height in platform units
is_enabled	bool	—	Defaults to true
description	string	—	Optional description

Response

{
  "status": "Success",
  "pageId": "page-guid"
}

---

update_page

Updates properties of an existing page. Null optional fields leave the current value unchanged; empty string clears nullable string fields.

Parameters

Name	Type	Required	Description
session_id	string	✅	Session id from create_session
asset_id	string	✅	Asset id (used for scoping)
id_page	string	✅	Page id from get_pages
friendly_name	string	—	New display name
order	int	—	New tab position
width	decimal	—	New canvas width
height	decimal	—	New canvas height
is_enabled	bool	—	Visibility flag
description	string	—	New description (empty string to clear)

Response

{ "status": "Success" }

---

delete_page

Deletes a page and all its visuals, projections, and filters (cascade delete).

Parameters

Name	Type	Required	Description
session_id	string	✅	Session id from create_session
page_id	string	✅	Page id from get_pages

Response

{ "status": "Success" }