Let the platform do the work
SugarClubContact+1 (877) 842-7276

/Dashboards/ GET

Overview

List current user's filtered dashboards.

Summary

This endpoint will return a set of dashboards filtered by an expression. The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id. If both a filter definition and a filter id are passed, currently the definition will override the id, but please do not rely on this behavior as it is subject to change. Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise the runtime of the endpoint will be very long.

Notice

This endpoint is not supported in v11. If you continue to use v10 of the API, your REST calls should behave as below. But, it is advisable to upgrade to v11.
Migrating to v11:
For more information on behavior in v11, refer to GET /<module>.
Recommended Replacement: GET /Dashboards

The module name is no longer part of the path. To specify a module name, include it as a filter parameter. For example, to retrieve all dashboards from the Accounts module, use
v11: GET /Dashboards?filter[0][dashboard_module]=Accounts

name, id. etc. are no longer specified as default fields. To retain the default fields, use
v11: GET /Dashboards?filter[0][dashboard_module]=Accounts&fields=id,name,view_name

Request Arguments

Name Type Description Required
filter String See Filter API. False
filter_id String Identifier for a preexisting filter. See the Filter API for details. False
max_num Integer Max number of records that can be returned. Default is 20. False
offset Integer The number of records to skip over before records are returned. Default is 0. False
fields String Comma delimited list of fields to return. Each field may be represented either by string, or by map containing field name and additional field parameters (applicable to link and collection fields). The fields id and date_modified will always be returned. For more details on additional field parameters, see Relate API and Collection API. False
order_by String See Filter API. False
deleted Boolean Boolean to show deleted records in the result set. False

Response Arguments

Name Type Description
next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records Array An array of results containing matched records.

Response

{
  "next_offset": -1,
  "records": [
    {
      "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
      "name": "Accounts Dashboard",
      "date_modified": "2016-03-29T09:46:00-07:00",
      "view_name": "records",
      "_acl": {
        "fields": {}
      },
      "view": "records",
      "_module": "Dashboards"
    },
    {
      "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
      "name": "Contacts Dashboard",
      "date_modified": "2016-03-29T09:57:58-07:00",
      "view_name": "records",
      "_acl": {
        "fields": {}
      },
      "view": "records",
      "_module": "Dashboards"
    }
  ]
}

Change Log

Version Change
v11 No longer supported. Please use GET /Dashboards instead.
v10 Added /Dashboards/<module> GET endpoint.

Topics