Wix Answers Help Center
Saved Filter APIs
A saved filter creates a custom view in the agent front-end app. Saved filters are either for tickets or for chats. In the knowledge center, agents can use saved filters to see the number of tickets or chats matching predefined criteria, and to view easily all those tickets or chats. In addition, saved filters are either public or private; only you can interact with your own private filters.
A saved filter is composed of one or more ticket filters, each of which filters tickets or chats by a specific criteria, such as (for tickets) whether the ticket has a label or was assigned by a particular agent (in the app, or (for chats) what the chat status is. In the knowledge base, ticket filters for tickets are divided into ticket filters, agent filters, call filters, and custom field filters (but in the API these are all called ticket filters).
Maximum Number of Saved Filters
You can have a maximum of 120 public saved filters total, for all locales. Each user can have a maximum of 50 private saved filters total, for all locales.
Unique Names
Filter names must be unique. You can't have two filters with the same name, even in two different locales.
Add a Saved Filter
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters
Add a saved filter.
- Authorization: Requires agent authorization token.
- If type is set to 20 (public) and context is set to 0 (ticket) in the payload, then permission MANAGE_SHARED_TICKET_VIEWS is also required.
- If type is set to 10 (public) and context is set to 0 (ticket) in the payload, then permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- If type is set to 20 (public) and context is set to 10 (chat) in the payload, then permission MANAGE_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Saved Filter object
Payload Params | Description | Type | Required |
---|---|---|---|
name | The saved filter name The name must be unique for each locale. | String, between 1 and 50 characters | ✓ |
type | Enter either Private (10) or Public (20). Only you can see your own private saved filters. | Integer, either 10 or 20 | ✓ |
filter | Ticket filters structure For more information, see the filters value in the Saved Filter object. | Structure | ✓ Although this parameter is required, no specific filter value is required. |
brandFilters | Brand filters structure For more information, see the brandFilters value in the Saved Filter object. | Structure | |
context | 0 (ticket) or 10 (chat) 0 is the default. | ||
locale | The locale for the saved filter | Language code string, for example: 'de' | |
oneInboxSorts | Sort criteria of active and inactive tickets, as follows: * activeListSortType (integer): Primary sort criteria for list of active tickets * activeListSecondarySortType (integer): Secondary sort criteria for list of active tickets * inactiveListSortType (integer): Primary sort criteria for list of inactive tickets * inactiveListSecondarySort (integer): Secondary sort criteria for list of inactive tickets For sort criteria options, see Search Tickets (Agent). | Structure | |
oneInboxDisplayedColumns | List of ticket fields that appear when viewing tickets of a saved filter as a table. Each column is a structure of: * columnName (string, required): A saved filter column name * width (integer): column width, in pixels | List of structures The maximum number of fields to appear is 50. |
Payload Example:
1 2 3 4 5 6 7 8 9
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters { "name": "Spam", "type": 10, "filter": { "spam": true }, "context": 0, "locale": "en" }
Get a Saved Filter
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/{saved filter GUID}
Get a public saved filter, or one of your own private saved filters.
Get a public saved filter, or one of your own private saved filters.
- Authorization: Requires agent authorization token; must be for specific user to view your own private filter. In addition:
- For a private filter, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- For a public ticket filter, permission FETCH_TICKET_VIEWS is also required.
- For a public chat filter, permission FETCH_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Saved Filter object
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920
Get Saved Filters
Deprecated
This endpoint is deprecated and will be removed, soon. See the next section for the new endpoint.
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters?locale=<locale>
Get all public ticket or chat saved filters, as well as all of your own private saved filters, for one locale.
Get all public ticket or chat saved filters, as well as all of your own private saved filters, for one locale.
- Authorization: Requires agent authorization token; must be for specific user to view your own private filters. In addition:
- To include your private filters, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- To include public ticket filters, permission FETCH_TICKET_VIEWS is also required.
- To include public chat filters, permission FETCH_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Saved Filter objects
Request Params | Description | Type | Required |
---|---|---|---|
context | 0 (ticket) or 10 (chat) 0 is the default. | ||
locale | The locale for the saved filters | Language code string, for example: 'de' | ✓ |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters?locale=en
Get Saved Filters (New)
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/new
Get all public ticket saved filters, as well as all of your own private saved filters, for one or more locales.
Get all public ticket saved filters, as well as all of your own private saved filters, for one or more locales.
- Authorization: Requires agent authorization token; must be for specific user to view your own private filters. In addition:
- To include your private filters, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- To include public ticket filters, permission FETCH_TICKET_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Saved Filter objects
Payload Params | Description | Type |
---|---|---|
locales | List of languages | Comma-separated list of language code strings, for example: "en,de" If not sent, the default is all locales. |
brandFilters | Brand filters, a structure of: * bandIds (list of GUIDs): Return saved filters that filter for all of the listed brands * includeBrandless (Boolean): When true, return saved filters that filter for tickets not associated with a brand | Structure |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/new?locales=en
Get Saved Filters for One or More Locales
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/perLocale
Get all public ticket or chat saved filters, as well as all of your own private saved filters, for the specified language(s).
Get all public ticket or chat saved filters, as well as all of your own private saved filters, for the specified language(s).
- Authorization: Requires agent authorization token; must be for specific user to view your own private filters. In addition:
- To include your private filters, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- To include public ticket filters, permission FETCH_TICKET_VIEWS is also required.
- To include public chat filters, permission FETCH_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Structure, see below
Request Params | Description | Type | Required |
---|---|---|---|
context | 0 (ticket) or 10 (chat) 0 is the default. | ✓ | |
locales | List of languages | Comma-separated list of language code strings, for example: "en,de" | ✓ At least one locale is required. |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/perLocale?context=10&languages=en,de
Response Example:
Response Params | Description | Type |
---|---|---|
filtersPerLocale | A map of locales to Saved Filter objects | Structure |
1 2 3 4 5 6
{ "filtersPerLocale": { "de": [@saved Filter object, @Saved Filter object, ...], "en": [@Saved Filter object] } }
Update Saved Filter Criteria
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/{saved filter GUID}/new
Update the ticket filters of a public saved filter, or one of your own private saved filters. See Important Information about Updating Using the API.
- Authorization: Requires agent authorization token; must be for specific user to update your own private filter.
- For a public ticket filter, permission MANAGE_SHARED_TICKET_VIEWS is also required.
- For a private ticket filter, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- For a public chat filter, permission MANAGE_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Saved filter language | Language code string, for example: 'de' | |
filters | Ticket filters structure For more information, see the filters value in the Saved Filter object. | Structure | ✓ Although this parameter is required, no specific filter value is required. |
brandFilters | Brand filters structure For more information, see the brandFilters value in the Saved Filter object. | Structure | |
oneInboxSorts | Sort criteria of active and inactive tickets, as follows: * activeListSortType (integer): Primary sort criteria for list of active tickets * activeListSecondarySortType (integer): Secondary sort criteria for list of active tickets * inactiveListSortType (integer): Primary sort criteria for list of inactive tickets * inactiveListSecondarySort (integer): Secondary sort criteria for list of inactive tickets For sort criteria options, see Search Tickets (Agent). | Sturcture | |
oneInboxDisplayedColumns | List of ticket fields that appear when viewing tickets of a saved filter as a table. Each column is a structure of: * columnName (string, required): A saved filter column name * width (integer): column width | List of structures Max is 50. |
Payload Example:
1 2 3 4 5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/d367738e-368e-41fe-9289-1a5cbbc3c239 { "filter": { "spam": false } }
Rename a Saved Filter
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/{saved filter GUID}/rename
Rename a public saved filter, or one of your own private saved filters. See Important Information about Updating Using the API.
- Authorization: Requires agent authorization token; must be for specific user to rename your own private filter.
- For a public ticket filter, permission MANAGE_SHARED_TICKET_VIEWS is also required.
- For a private ticket filter, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- For a public chat filter, permission MANAGE_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Payload Params | Description | Type | Required |
---|---|---|---|
name | The new saved filter name | String, between 1 and 50 characters | ✓ |
Payload Example:
1 2 3 4 5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/d367738e-368e-41fe-9289-1a5cbbc3c239/rename { "name": "Not Spam" }
Delete a Saved Filter
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/{saved filter GUID}
Delete a public saved filter, or one of your own private saved filters.
- Authorization: Requires agent authorization token; must be for specific user to delete your own private filter.
- For a public ticket filter, permission MANAGE_SHARED_TICKET_VIEWS is also required.
- For a private ticket filter, permission MANAGE_PRIVATE_TICKET_VIEWS is also required.
- For a public chat filter, permission MANAGE_CHAT_VIEWS is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedFilters/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920
Was this article helpful?