Product Documentation

Get Report Groups

Last updated on 28 September, 2020

You can use LogicMonitor’s REST API to programmatically get information about your LogicMonitor report groups. You can either get a list of report groups or you can get details for a particular report group.

As with all of our API calls, authentication is required.

 

Get a list of Report Groups

Returns a list of reports

HTTP Method: GET

URI: /report/groups

Request Parameters: By default, a list of 50 report 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.  Note that all query parameters should be URL encoded where necessary. Additionally, note that query parameters are not considered part of the resource path, and should not be included the calculation of the LMv1 authentication signature.

 

Property

Syntax

Description

Example URI
sort sort={+ or -}property Sorts the response by the property specified in either increasing (+) or decreasing (-) order /report/groups?sort=+name
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:

  • Greater than or equals: >:
  • Less than or equals: <:
  • Greater than: >
  • Less than: <
  • Does not equal: !:
  • Equals: :
  • Does not include: !~
  • Includes: ~
 /report/groups?filter=name:Prod%20alerts
fields fields={list of properties separated by commas} Filters the response to only include the following fields for each object /report/groups?fields=name,reportsCount
size size=integer The number of results to display. Max is 1000. /report/groups?size=5
offset offset=integer The number of results to offset the displayed results by /report/groups?offset=2

 

 

Get information about a particular report group

Returns details for a particular report group

 

HTTP Method:GET

URI: /report/groups/{id}

 

 

In This Article