Getting Dashboard Group Details
Last updated on 07 October, 2024You can use LogicMonitor REST API v3 to get dashboard group details. You must authenticate yourself before making the API request.
Getting List of Dashboard Groups
You can include the following query parameters to control the kind of data to include in the response and how it is formatted.
URI: GET /dashboard/groups
Query Parameter | Type | Description |
fields | String | The response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. Example – /dashboard/groups?fields=id,description |
size | Integer | Indicates the number of results to display. A maximum of 1000 results can be requested in a GET call. By default, a list of 50 dashboard groups is returned if a value is not provided for this parameter. Example – /dashboard/groups?size=5 |
offset | Integer | Indicates the number of results to offset the displayed results. Example – /dashboard/groups?offset=2 |
filter | String | The response is filtered according to the operator and specified value that is, filter=property:value
/dashboard/groups?filter=name!~CAG* |
Getting Details of Specific Dashboard Group
URI: GET /dashboard/groups/{id}
Parameter | Type | Description |
id | Integer | (Mandatory) The Id of the dashboard group that you want to get. |
template | Boolean | Indicates if the API request should return the response in template format which can be used to import dashboard groups. By default, it is set to false . |
format | String | It is used in combination with the template parameter. Supported values are JSON (default) or file . |
fields | String | The response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. Example – /dashboard/groups/id?fields=id,description |