Gets the full URL for a dashboard page.
(destination: Destination) => Promise<string>;| Name | Type | Description |
|---|---|---|
destination | Destination | URL destination details. |
{
pageId: string;
relativeUrl?: string;
}| Name | Type | Description |
|---|---|---|
pageId | string | ID of the page to link to. Use the Page IDs table to find the appropriate ID. |
relativeUrl | string | Optional. URL segment to append to the base URL of the selected page. Can include path segments, a query string, and a fragment identifier. |
Promise<string>
The URL of a dashboard page with the provided relativeUrl value appended.
To set up a dashboard client, refer to the setup guide.
const pageUrl = await client.dashboard.getPageUrl({
pageId: "home",
relativeUrl: "?referal=page-3",
});