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

# IDataFiltersService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/dataFilter/index.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).
> 

The service that returns information about data filters.

Supports both Workspace Data Filters and User Data Filters.

**Signature:**

```typescript
export interface IDataFiltersService 
```

## Methods

| Method | Description |
| --- | --- |
| [createDataFilter(newDataFilter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicecreatedatafilter) | **_(ALPHA)_** Create a new data filter (without setting). |
| [createDataFilterSetting(definition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicecreatedatafiltersetting) | **_(ALPHA)_** Create a new setting of a data filter. Unlike , this does not remove the existing settings of the data filter. |
| [createUserDataFilter(newUserDataFilter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicecreateuserdatafilter) | **_(ALPHA)_** Create a new user data filter. |
| [deleteDataFilter(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicedeletedatafilter) | **_(ALPHA)_** Delete an existing data filter. |
| [deleteUserDataFilter(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicedeleteuserdatafilter) | **_(ALPHA)_** Delete an existing user data filter. |
| [getDataFilters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicegetdatafilters) | **_(ALPHA)_** Get data filters for the current workspace with their settings. |
| [getUserDataFilters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicegetuserdatafilters) | **_(ALPHA)_** Get all user data filters for the current workspace. |
| [getWorkspaceDataFilters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersservicegetworkspacedatafilters) | **_(ALPHA)_** Get data filters for the current workspace with their settings. |
| [updateDataFilter(updatedDataFilter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersserviceupdatedatafilter) | **_(ALPHA)_** Update an existing data filter. The setting is not updated, only the data filter. |
| [updateDataFilterValue(dataFilter, values)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersserviceupdatedatafiltervalue) | **_(ALPHA)_** Update value of existing data filter. |
| [updateUserDataFilter(updatedUserDataFilter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md#idatafiltersserviceupdateuserdatafilter) | **_(ALPHA)_** Update an existing user data filter. |

## Method details

### IDataFiltersService.createDataFilter()

> **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).
> 

Create a new data filter (without setting).

**Signature:**

```typescript
createDataFilter(newDataFilter: IWorkspaceDataFilterDefinition): Promise<IWorkspaceDataFilter>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| newDataFilter | [IWorkspaceDataFilterDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacedatafilterdefinition/index.md) |  |

**Returns:**

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

### IDataFiltersService.createDataFilterSetting()

> **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).
> 

Create a new setting of a data filter. Unlike , this does not remove the existing settings of the data filter.

**Signature:**

```typescript
createDataFilterSetting(definition: IWorkspaceDataFilterSettingDefinition): Promise<IWorkspaceDataFilterSetting>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| definition | [IWorkspaceDataFilterSettingDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacedatafiltersettingdefinition/index.md) | data filter, values and optional id, title and description of the setting |

**Returns:**

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

### IDataFiltersService.createUserDataFilter()

> **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).
> 

Create a new user data filter.

**Signature:**

```typescript
createUserDataFilter(newUserDataFilter: UserDataFilterDefinition): Promise<UserDataFilter>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| newUserDataFilter | [UserDataFilterDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.userdatafilterdefinition/index.md) |  |

**Returns:**

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

### IDataFiltersService.deleteDataFilter()

> **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).
> 

Delete an existing data filter.

**Signature:**

```typescript
deleteDataFilter(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) |  |

**Returns:**

Promise&lt;void&gt;

### IDataFiltersService.deleteUserDataFilter()

> **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).
> 

Delete an existing user data filter.

**Signature:**

```typescript
deleteUserDataFilter(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) |  |

**Returns:**

Promise&lt;void&gt;

### IDataFiltersService.getDataFilters()

> **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).
> 

Get data filters for the current workspace with their settings.

**Signature:**

```typescript
getDataFilters(): Promise<IWorkspaceDataFilter[]>;
```
**Returns:**

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

### IDataFiltersService.getUserDataFilters()

> **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).
> 

Get all user data filters for the current workspace.

**Signature:**

```typescript
getUserDataFilters(): Promise<UserDataFilter[]>;
```
**Returns:**

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

### IDataFiltersService.getWorkspaceDataFilters()

> **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).
> 

> Warning: This API is now obsolete.
> 
> - the function has been renamed, use  instead
> 

Get data filters for the current workspace with their settings.

**Signature:**

```typescript
getWorkspaceDataFilters(): Promise<IWorkspaceDataFilter[]>;
```
**Returns:**

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

### IDataFiltersService.updateDataFilter()

> **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).
> 

Update an existing data filter. The setting is not updated, only the data filter.

**Signature:**

```typescript
updateDataFilter(updatedDataFilter: IWorkspaceDataFilter): Promise<IWorkspaceDataFilter>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedDataFilter | [IWorkspaceDataFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacedatafilter/index.md) |  |

**Returns:**

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

### IDataFiltersService.updateDataFilterValue()

> **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).
> 

Update value of existing data filter.

**Signature:**

```typescript
updateDataFilterValue(dataFilter: ObjRef, values: string[]): Promise<void>;
```

#### Parameters

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

**Returns:**

Promise&lt;void&gt;

### IDataFiltersService.updateUserDataFilter()

> **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).
> 

Update an existing user data filter.

**Signature:**

```typescript
updateUserDataFilter(updatedUserDataFilter: UserDataFilter): Promise<UserDataFilter>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedUserDataFilter | [UserDataFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.userdatafilter/index.md) |  |

**Returns:**

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