/Dashboards GET

Overview

List current user's filtered Home dashboards.

Summary

This endpoint will return a set of Home 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, the two filters will be joined with an AND. 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

The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to GET /<module>. If you continue to use v10 of the API, your REST calls should behave as before. But, it is advisable to upgrade to v11. Slight differences exist in the GET method of v10 vs v11.
Migrating to v11:
Recommended Replacement: GET /Dashboards

The Home module is no longer the default dashboard_module. To get the Home module dashboard, include the following filter parameter.
v11: GET /Dashboards?filter[0][dashboard_module]=Home

name, id. etc. are no longer specified as default fields. To retain the default fields, use
v11: GET /Dashboards?filter[0][dashboard_module]=Home&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, unless overruled by your Sugar configuration.	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": "c630c772-faca-2051-6a42-56fab2e73e42",
      "name": "New Home Dashboard",
      "date_modified": "2016-03-29T09:49:06-07:00",
      "view_name": "",
      "_acl": {
        "fields": {}
      },
      "view": "",
      "_module": "Dashboards"
    },
    {
      "id": "15677f2c-f00d-c59a-6fbe-56fab1f33732",
      "name": "Home Dashboard2",
      "date_modified": "2016-03-29T09:47:25-07:00",
      "view_name": "",
      "_acl": {
        "fields": {}
      },
      "view": "",
      "_module": "Dashboards"
    },
    {
      "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": "Activity Stream Dashboard",
      "date_modified": "2016-03-29T09:57:58-07:00",
      "view_name": "activities",
      "_acl": {
        "fields": {}
      },
      "view": "activities",
      "_module": "Dashboards"
    }
  ]
}

Change Log

Version	Change
v11	Behavior has changed. Please see GET /Dashboards for the designated replacement.
v10	Added `/Dashboards` GET endpoint.