Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

# getPageUrl

Gets the full URL for a dashboard page.

## Signature

```ts
(destination: Destination) => Promise<string>
```

## Parameters

| Name          | Type                               | Description     |
|:--------------|:-----------------------------------|:----------------|
| `destination` | [Destination](fallback::#destination) | URL destination details. |

### Destination Object
```ts
{
    pageId: string;
    relativeUrl?: string;
}
```

| Name           | Type     | Description                                                                                            |
|:---------------|:---------|:-------------------------------------------------------------------------------------------------------|
| `pageId`       | `string` | ID of the page to link to. Use the [Page IDs](resourceId::0060a5f1-d5a9-49b7-bb59-324f852450da*fallback::https://github.com/wix-private/developer-docs/blob/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/page-ids.md) 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. |

## Returns
```
Promise<string>
```

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

## Examples

To set up a dashboard client, refer to the [setup](resourceId::b5088d52-82f9-44cc-b1a2-fea83606d85d#setup*fallback::https://github.com/wix-private/developer-docs/blob/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/intro.md#setup) guide.

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

```js
const pageUrl = await client.dashboard.getPageUrl({pageId: 'home', relativeUrl: '?referal=page-3'});
```

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.