> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# drillToCustomUrl()

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: function
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/drill.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates the [IDrillToCustomUrl](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idrilltocustomurl/index.md) command. Dispatching this command will result into resolving the target url and dispatching [IDashboardDrillToCustomUrlResolved](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboarddrilltocustomurlresolved/index.md) event that will contain it.

Custom url can contain various identifier or attribute title placeholders, see: [https://help.gooddata.com/pages/viewpage.action?pageId=86794855](https://help.gooddata.com/pages/viewpage.action?pageId=86794855)

**Signature:**

```typescript
export declare function drillToCustomUrl(drillDefinition: IDrillToCustomUrlModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToCustomUrl;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| drillDefinition | [IDrillToCustomUrlModel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idrilltocustomurl/index.md) | drill definition with the target url to resolve. |
| drillEvent | [IDashboardDrillEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboarddrillevent/index.md) | original drill event, that triggered this particular drill interaction. |
| correlationId | string | _(Optional)_ specify correlation id. It will be included in all events that will be emitted during the command processing. |

**Returns:**

[IDrillToCustomUrl](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idrilltocustomurl/index.md)

drill to custom url command