5.   Manage User Favorite Datasets

User Favorites

The Monitor+ API allows you to build, structure and manage a list of user “favorite” or frequently used datasets (time series). The ‘favorites’ list is designed to allow the user to create and manage their own selection of datasets from the many tens of thousands that may be available in their available datasources. The favorites list is available to any application that uses the API (the Xlerate Excel add in uses only the Monitor+ API for all data requests). It is very useful for creating applications for end users.

The User Favorites feature also has its own web application with an easy to use GUI. It provides an easy way for users to manage their favorites list, arrange their favorites list into a hierarchical data tree and provide automatic backup or restore facilities for their favorites list.

The favorite endpoints are:

• GetFavoritesStatus – Returns the dataset count and timestamp of the favorites list on the server.
• GetUserFavorites – Returns the metadata for the datasets contained in the users favorites list.
• AddFavorites – Add one or more datasets to your list of user favorite datasets.
• RemoveFavorites – Remove one or more datasets from your favorites list.
• GetDeletedFavorites – Return a list of datasets that have been removed from your favorites list.