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

# IWorkspaceInsightsService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/insights/index.ts

Service to query, update or delete insights, and other methods related to insights. Check IInsight for more details.

**Signature:**

```typescript
export interface IWorkspaceInsightsService 
```

## Methods

| Method | Description |
| --- | --- |
| [createInsight(insight, generatedId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicecreateinsight) | Create and save insight for the provided insight definition |
| [deleteInsight(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicedeleteinsight) | Delete insight with the given reference |
| [getInsight(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsight) | Request insight for the given reference |
| [getInsightReferencedObjects(insight, types)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsightreferencedobjects) | Get all metadata objects referenced by a given insight. |
| [getInsightReferencingObjects(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsightreferencingobjects) | Get all metadata objects which uses specified object(ie. object is used by these objects) by a given reference. |
| [getInsights(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsights) | Queries workspace insights, using various criteria and paging settings. |
| [getInsightsQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsightsquery) | List insights |
| [getInsightWithAddedFilters(insight, filters)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsightwithaddedfilters) | Get insight with the filters provided merged with the filters specified by the insight itself. |
| [getInsightWithCatalogItems(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetinsightwithcatalogitems) | Request insight for the given reference together with related catalog items |
| [getVisualizationClass(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetvisualizationclass) | Request visualization class for the given reference |
| [getVisualizationClasses(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicegetvisualizationclasses) | Request all visualization classes |
| [setCertification(ref, certification)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsservicesetcertification) | Sets insight certification metadata. |
| [updateInsight(insight)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsserviceupdateinsight) | Update provided insight |
| [updateInsightMeta(insight)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md#iworkspaceinsightsserviceupdateinsightmeta) | Update metadata object for the insight |

## Method details

### IWorkspaceInsightsService.createInsight()

Create and save insight for the provided insight definition

**Signature:**

```typescript
createInsight(insight: IInsightDefinitionWithOptionalIdentity, generatedId?: boolean): Promise<IInsight>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| insight | [IInsightDefinitionWithOptionalIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsightdefinitionwithoptionalidentity/index.md) | insight definition |
| generatedId | boolean | _(Optional)_ if true, backend will generate insight id, otherwise the id must be provided in the insight definition, defaults to true |

**Returns:**

Promise&lt;[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)&gt;

promise of created insight

### IWorkspaceInsightsService.deleteInsight()

Delete insight with the given reference

**Signature:**

```typescript
deleteInsight(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the insight to delete |

**Returns:**

Promise&lt;void&gt;

promise of undefined

### IWorkspaceInsightsService.getInsight()

Request insight for the given reference

**Signature:**

```typescript
getInsight(ref: ObjRef, options?: IGetInsightOptions): Promise<IInsight>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | insight reference |
| options | [IGetInsightOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetinsightoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)&gt;

promise of insight

### IWorkspaceInsightsService.getInsightReferencedObjects()

Get all metadata objects referenced by a given insight.

**Signature:**

```typescript
getInsightReferencedObjects(insight: IInsight, types?: SupportedInsightReferenceTypes[]): Promise<IInsightReferences>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| insight | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | insight to get referenced objects for |
| types | [SupportedInsightReferenceTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.supportedinsightreferencetypes/index.md)[] | _(Optional)_ optional array of object types to include, when not specified, all supported references will be retrieved |

**Returns:**

Promise&lt;[IInsightReferences](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iinsightreferences/index.md)&gt;

### IWorkspaceInsightsService.getInsightReferencingObjects()

Get all metadata objects which uses specified object(ie. object is used by these objects) by a given reference.

**Signature:**

```typescript
getInsightReferencingObjects(ref: ObjRef): Promise<IInsightReferencing>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the insight to get referencing objects for |

**Returns:**

Promise&lt;[IInsightReferencing](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iinsightreferencing/index.md)&gt;

### IWorkspaceInsightsService.getInsights()

Queries workspace insights, using various criteria and paging settings.

**Signature:**

```typescript
getInsights(options?: IInsightsQueryOptions): Promise<IInsightsQueryResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IInsightsQueryOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iinsightsqueryoptions/index.md) | _(Optional)_ query options; if not specified defaults to no sorting, no filtering and 50 items per page |

**Returns:**

Promise&lt;[IInsightsQueryResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iinsightsqueryresult/index.md)&gt;

paged results, empty page with zero total count if there are no insights stored in the workspace

### IWorkspaceInsightsService.getInsightsQuery()

List insights

**Signature:**

```typescript
getInsightsQuery(): IInsightsQuery;
```
**Returns:**

[IInsightsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iinsightsquery/index.md)

methods for querying insights

### IWorkspaceInsightsService.getInsightWithAddedFilters()

Get insight with the filters provided merged with the filters specified by the insight itself.

**Signature:**

```typescript
getInsightWithAddedFilters<T extends IInsightDefinition>(insight: T, filters: IFilter[]): Promise<T>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| insight | T | insight to start with |
| filters | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | filters to merge |

**Returns:**

Promise&lt;T&gt;

promise of new insight with the filters merged in

### IWorkspaceInsightsService.getInsightWithCatalogItems()

Request insight for the given reference together with related catalog items

**Signature:**

```typescript
getInsightWithCatalogItems(ref: ObjRef, options?: IGetInsightOptions): Promise<{
        insight: IInsight;
        catalogItems: Array<ICatalogFact | ICatalogMeasure | ICatalogAttribute>;
    }>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | insight reference |
| options | [IGetInsightOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetinsightoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;{ insight: [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md); catalogItems: Array&lt;[ICatalogFact](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogfact/index.md) &#124; [ICatalogMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogmeasure/index.md) &#124; [ICatalogAttribute](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icatalogattribute/index.md)&gt;; }&gt;

promise of catalog item of type metric or fact

### IWorkspaceInsightsService.getVisualizationClass()

Request visualization class for the given reference

**Signature:**

```typescript
getVisualizationClass(ref: ObjRef): Promise<IVisualizationClass>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | visualization class reference |

**Returns:**

Promise&lt;[IVisualizationClass](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ivisualizationclass/index.md)&gt;

promise of visualization class

### IWorkspaceInsightsService.getVisualizationClasses()

Request all visualization classes

**Signature:**

```typescript
getVisualizationClasses(options?: IGetVisualizationClassesOptions): Promise<IVisualizationClass[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IGetVisualizationClassesOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetvisualizationclassesoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;[IVisualizationClass](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ivisualizationclass/index.md)[]&gt;

promise of visualization classes

### IWorkspaceInsightsService.setCertification()

Sets insight certification metadata.

**Signature:**

```typescript
setCertification(ref: ObjRef, certification?: IObjectCertificationWrite): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | insight reference |
| certification | IObjectCertificationWrite | _(Optional)_ certification state; undefined clears certification |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceInsightsService.updateInsight()

Update provided insight

**Signature:**

```typescript
updateInsight(insight: IInsight): Promise<IInsight>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| insight | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | insight to update |

**Returns:**

Promise&lt;[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)&gt;

promise of updated insight

### IWorkspaceInsightsService.updateInsightMeta()

Update metadata object for the insight

**Signature:**

```typescript
updateInsightMeta(insight: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IInsight>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| insight | Partial&lt;[IMetadataObjectBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imetadataobjectbase/index.md)&gt; &amp; [IMetadataObjectIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imetadataobjectidentity/index.md) | metadata object to update |

**Returns:**

Promise&lt;[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)&gt;

promise of updated measure