/Info/Favorites

Returns information about favorites for the current user.

Request Method

GET

URL Parameters

None.

Request Body Details

This endpoint ignores the request body.

Example Request

Request Method:
GET
Request URL:
https://localhost/api/deepsee/v3/Info/Favorites
For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Example Response

{
  "Info": {
    "Error": "",
    "User": "TestUser"
  },
  "Result": {
    "Favorites": [
      {
        "fullName": "Data-Driven Colors.dashboard",
        "shortName": "Data-Driven Colors",
        "folder": "",
        "tip": "Data-Driven Colors",
        "type": "Dashboard",
        "icon": "deepsee/ds2_dashboard_44.png",
        "addDate": "2024-03-11 20:02:35.881",
        "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Data-Driven%20Colors.dashboard"
      },
      {
        "fullName": "Ens/Analytics/ActivityVolumeAndDuration.dashboard",
        "shortName": "Activity Volume And Duration",
        "folder": "Ens/Analytics",
        "tip": "Activity Volume And Duration",
        "type": "Dashboard",
        "icon": "deepsee/ds2_dashboard_44.png",
        "addDate": "2024-03-11 19:55:12.236",
        "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Ens/Analytics/ActivityVolumeAndDuration.dashboard"
      },
      {
        "fullName": "Listing with Filters.dashboard",
        "shortName": "Listing with Filters",
        "folder": "",
        "tip": "Listing with Filters",
        "type": "Dashboard",
        "icon": "deepsee/ds2_dashboard_44.png",
        "addDate": "2024-03-11 20:02:35.867",
        "url": "_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=Listing%20with%20Filters.dashboard"
      }
    ]
  }
}

In the response object, the Result property contains a property called FilterMembers, which contains an array of objects, one for each filter member. The object for a given filter member contains the following properties:

description contains the text description of the member, if any
text contains the display text for the member
value contains the logical value of the member (typically the MDX key)

For information that applies to all response objects, see Notes on the Response Objects.

/Info/FilterMembers/:datasource/:filterSpec

/Info/DataSources/:sourceType