> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSDashAgent

> Carrier object for managing various dashboard operations.

Carrier object for managing various dashboard operations.

## Constructors

### NSDashAgent()

```crmscript theme={null}
NSDashAgent
```

Initializes a new instance of the NSDashAgent class.

## Methods

## AddNewTileToDashboard(Integer, NSDashTileDefinition)

Adds a new tile to the specified dashboard.

```crmscript theme={null}
NSDashTile AddNewTileToDashboard(Integer dashboardId, NSDashTileDefinition tileDefinition)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## AddTileToDashboard(Integer, Integer)

Adds an existing tile to a specified dashboard.

```crmscript theme={null}
NSDashTile AddTileToDashboard(Integer dashboardId, Integer tileId)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## CopyTileSelection(Integer)

Copies the specified tile selection.

```crmscript theme={null}
Integer CopyTileSelection(Integer selectionId)
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)

## CreateDashTileSelectionFromEntity(String)

Creates a dash tile selection based on the specified entity.

```crmscript theme={null}
Integer CreateDashTileSelectionFromEntity(String entity)
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)

## CreateDefaultDash

Generates a default dashboard.

```crmscript theme={null}
NSDash CreateDefaultDash()
```

**Returns:** [CRMScript.NetServer.NSDash](CRMScript.NetServer.NSDash)

## CreateDefaultDashCollection

Generates a default collection of dashboards.

```crmscript theme={null}
NSDashCollection CreateDefaultDashCollection()
```

**Returns:** [CRMScript.NetServer.NSDashCollection](CRMScript.NetServer.NSDashCollection)

## CreateDefaultDashTheme

Creates a default theme for dashboards.

```crmscript theme={null}
NSDashTheme CreateDefaultDashTheme()
```

**Returns:** [CRMScript.NetServer.NSDashTheme](CRMScript.NetServer.NSDashTheme)

## CreateDefaultDashTile

Generates a default tile for dashboards.

```crmscript theme={null}
NSDashTile CreateDefaultDashTile()
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## CreateDefaultDashTileDefinition

Creates a default definition for a dashboard tile.

```crmscript theme={null}
NSDashTileDefinition CreateDefaultDashTileDefinition()
```

**Returns:** [CRMScript.NetServer.NSDashTileDefinition](CRMScript.NetServer.NSDashTileDefinition)

## CreateDefaultPreviewDash

Generates a default preview dashboard.

```crmscript theme={null}
NSPreviewDash CreateDefaultPreviewDash()
```

**Returns:** [CRMScript.NetServer.NSPreviewDash](CRMScript.NetServer.NSPreviewDash)

## CreateDefaultPreviewDashTile

Creates a default tile for preview dashboards.

```crmscript theme={null}
NSPreviewDashTile CreateDefaultPreviewDashTile()
```

**Returns:** [CRMScript.NetServer.NSPreviewDashTile](CRMScript.NetServer.NSPreviewDashTile)

## CreateDefaultTileForEntity(String)

Creates a default tile for the specified entity.

```crmscript theme={null}
NSDashTile CreateDefaultTileForEntity(String entity)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## DeleteDash(Integer)

Deletes a specified dashboard.

```crmscript theme={null}
Void DeleteDash(Integer dashId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## DeleteDashTheme(Integer)

Deletes the specified dashboard theme.

```crmscript theme={null}
Void DeleteDashTheme(Integer themeId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## DeleteDashTile(Integer)

Deletes a specified dashboard tile.

```crmscript theme={null}
Void DeleteDashTile(Integer tileId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## DeleteDashTileDefinition(Integer)

Deletes the specified tile definition.

```crmscript theme={null}
Void DeleteDashTileDefinition(Integer tileDefinitionId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## DuplicateDashboard(Integer, String)

Creates a copy of the specified dashboard with a new name.

```crmscript theme={null}
NSDash DuplicateDashboard(Integer dashId, String newName)
```

**Returns:** [CRMScript.NetServer.NSDash](CRMScript.NetServer.NSDash)

## DuplicateTile(Integer, String)

Duplicates a tile with a new name.

```crmscript theme={null}
NSDashTile DuplicateTile(Integer tileId, String newName)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## GetDash(Integer)

Retrieves a specific dashboard by ID.

```crmscript theme={null}
NSDash GetDash(Integer dashId)
```

**Returns:** [CRMScript.NetServer.NSDash](CRMScript.NetServer.NSDash)

## GetDashCollection

Retrieves the current collection of dashboards.

```crmscript theme={null}
NSDashCollection GetDashCollection()
```

**Returns:** [CRMScript.NetServer.NSDashCollection](CRMScript.NetServer.NSDashCollection)

## GetDashList(Integer\[])

Retrieves a list of dashboards based on an array of IDs.

```crmscript theme={null}
NSDash[] GetDashList(Integer[] dashIds)
```

**Returns:** [CRMScript.NetServer.NSDash](CRMScript.NetServer.NSDash)\[]

## GetDashTheme(Integer)

Retrieves a specific dashboard theme by ID.

```crmscript theme={null}
NSDashTheme GetDashTheme(Integer themeId)
```

**Returns:** [CRMScript.NetServer.NSDashTheme](CRMScript.NetServer.NSDashTheme)

## GetDashTile(Integer)

Retrieves a specific tile from a dashboard by ID.

```crmscript theme={null}
NSDashTile GetDashTile(Integer tileId)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## GetDashTileDefinition(Integer)

Retrieves a tile definition by ID.

```crmscript theme={null}
NSDashTileDefinition GetDashTileDefinition(Integer tileDefinitionId)
```

**Returns:** [CRMScript.NetServer.NSDashTileDefinition](CRMScript.NetServer.NSDashTileDefinition)

## GetDashTileHtml(Integer, String)

Retrieves the HTML content for a specific dashboard tile.

```crmscript theme={null}
NSDashTileHtml GetDashTileHtml(Integer tileId, String context)
```

**Returns:** [CRMScript.NetServer.NSDashTileHtml](CRMScript.NetServer.NSDashTileHtml)

## GetDashTileHtmlList(Integer)

Retrieves a list of HTML content for all tiles in a dashboard.

```crmscript theme={null}
NSDashTileHtml[] GetDashTileHtmlList(Integer dashId)
```

**Returns:** [CRMScript.NetServer.NSDashTileHtml](CRMScript.NetServer.NSDashTileHtml)\[]

## GetDashTiles(Integer)

Retrieves all tiles in the specified dashboard.

```crmscript theme={null}
NSDashTile[] GetDashTiles(Integer dashId)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)\[]

## GetPreviewDash(Integer)

Retrieves a preview version of a specific dashboard.

```crmscript theme={null}
NSPreviewDash GetPreviewDash(Integer dashId)
```

**Returns:** [CRMScript.NetServer.NSPreviewDash](CRMScript.NetServer.NSPreviewDash)

## GetSecondaryTempTileSelection(Integer)

Retrieves the secondary temporary tile selection by ID.

```crmscript theme={null}
Integer GetSecondaryTempTileSelection(Integer selectionId)
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)

## GetTempTileSelection(Integer)

Retrieves the temporary tile selection by ID.

```crmscript theme={null}
Integer GetTempTileSelection(Integer selectionId)
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)

## SaveDash(NSDash)

Saves the specified dashboard with given data.

```crmscript theme={null}
NSDash SaveDash(NSDash dashData)
```

**Returns:** [CRMScript.NetServer.NSDash](CRMScript.NetServer.NSDash)

## SaveDashTheme(NSDashTheme)

Saves the specified dashboard theme.

```crmscript theme={null}
NSDashTheme SaveDashTheme(NSDashTheme theme)
```

**Returns:** [CRMScript.NetServer.NSDashTheme](CRMScript.NetServer.NSDashTheme)

## SaveDashTile(NSDashTile)

Saves the specified dashboard tile.

```crmscript theme={null}
NSDashTile SaveDashTile(NSDashTile tile)
```

**Returns:** [CRMScript.NetServer.NSDashTile](CRMScript.NetServer.NSDashTile)

## SaveDashTileDefinition(NSDashTileDefinition)

Saves the specified dashboard tile definition.

```crmscript theme={null}
NSDashTileDefinition SaveDashTileDefinition(NSDashTileDefinition tileDefinition)
```

**Returns:** [CRMScript.NetServer.NSDashTileDefinition](CRMScript.NetServer.NSDashTileDefinition)

## SaveDashTileHtmlList(Integer, NSDashTileHtml\[])

Saves a list of HTML content for dashboard tiles.

```crmscript theme={null}
NSDashTileHtml[] SaveDashTileHtmlList(Integer dashId, NSDashTileHtml[] tileHtmlList)
```

**Returns:** [CRMScript.NetServer.NSDashTileHtml](CRMScript.NetServer.NSDashTileHtml)\[]

## SaveDashTiles(Integer, NSDashTile\[])

Saves multiple tiles for the specified dashboard.

```crmscript theme={null}
Void SaveDashTiles(Integer dashId, NSDashTile[] tiles)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)


## Related topics

- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [Delete Dash](/en/api/reference/restful/agent/dash_agent/delete-dash.md)
- [Save Dash](/en/api/reference/restful/agent/dash_agent/save-dash.md)
- [Get Dash](/en/api/reference/restful/agent/dash_agent/get-dash.md)