About the Dashboard Favorite List API

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline Wix users' dashboard navigation experience and make important pages quickly accessible.

With the Dashboard Favorite List API, you can:

• Create, retrieve, update, and delete a user's list of dashboard favorites.
• Add and delete individual dashboard favorites from a user's list.
• Create nested views of collections, developer tools, or other dashboard pages for quick access.
• Assign custom titles to favorite pages for easier navigation.

Before you begin

It's important to note the following points before starting to code:

• Each Wix user can only have one list of favorite dashboard pages.
• We recommend you avoid making changes to the list without the user taking explicit action.

Use cases

• Increase app usage by including an Add to Favorites button in your app's dashboard page extensions.
• Create a nested view of frequently visited dashboard pages for quick access.
• Create a standalone Add to Favorites dashboard plugin extension that can be added to a supported dashboard page slot.

Terminology

• Dashboard Favorite List: A UI element that displays a list of favorite dashboard pages used for quick access.
• Dashboard Favorite Page: A dashboard favorite page on the list. It has a custom title, and it can have a relative URL.
• Page: A dashboard page.