Get Collector Groups
Last updated on 28 January, 2021Overview
You can use LogicMonitor’s REST API to programmatically get information about the Collector groups in your account. Specifically, you can get a list of Collector groups or information on a specific Collector group.
As with all of our API calls, authentication is required.
Get a List of All Collector Groups
HTTP Method: GET
URI: /setting/collectors/groups
Request Parameters: By default, a list of 50 Collector groups will be returned. You can include sort, filter, fields, size and offset parameters in your request to control what data is included in the response and how it is formatted.
| Property | Syntax | Description | Example URI |
| sort | sort={+ or -}property | Sorts the response by the property specified in either increasing (+) or decreasing (-) order | /setting/collectors/groups?sort=-id |
| filter | filter=property{operator}value | Filters the response according to the operator and value specified. Note that you can use * to match on more than one character.You can use the ‘.’ character to filter values within an object (e.g. custom properties), and multiple filters can be separated by a comma.
Operators include:
|
/setting/collectors/groups?filter=description~QA* |
| fields | fields={list of properties separated by commas} | Filters the response to only include the following fields for each object | /setting/collectors/groups?fields=id,description |
| size | size=integer | The number of results to display | /setting/collectors/groups?size=5 |
| offset | offset=integer | The number of results to offset the displayed results by | /setting/collectors/groups?offset=2 |
Get Information About a Particular Collector Group
HTTP Method: GET
URI: /setting/collectors/groups/<id>