getPageUrl

Gets the full URL for a dashboard page.

Signature

Copy

Parameters

NameTypeDescription
destinationDestinationURL destination details.

Destination Object

Copy
NameTypeDescription
pageIdstringID of the page to link to. Use the Page IDs table to find the appropriate ID.
relativeUrlstringOptional. URL segment to append to the base URL of the selected page. Can include path segments, a query string, and a fragment identifier.

Returns

Copy

The URL of a dashboard page with the provided relativeUrl value appended.

Examples

To set up a dashboard client, refer to the setup guide.

Get the URL of the dashboard's home page with a query string

Copy
Was this helpful?
Yes
No