Getting Report Group Details

Last updated on 11 July, 2023

You can use LogicMonitor REST API v3 to get report group details. You must authenticate yourself before making the API request.

Getting List of Report Groups

You can include the following query parameters to control the kind of data to include in the response and how it is formatted.

Note:

  • The query parameters are not part of the resource path and should not be included in the calculation of the LMv1 authentication signature.
  • If necessary, all query parameters should be URL encoded.

URI: GET /report/groups

ParameterTypeDescription
fieldsStringThe response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. 
Example – /report/groups?fields=name,reportsCount
sizeIntegerIndicates the number of results to display. A maximum of 1000 results can be requested in a GET call. By default, a list of 50 report groups is returned if a value is not provided for this parameter.
Example – /report/groups?size=5
offsetIntegerIndicates the number of results to offset the displayed results.
Example – /report/groups?offset=2
filterStringThe response is filtered according to the operator and specified value that is, filter=property:value
  • Use an asterisk (*) to match more than one character
  • Use a dot (.) character to filter values within an object (example – custom properties)
  • Use a comma (,) to separate multiple filters

Operators include:
  • Greater than or equals: >:
  • Less than or equals: <:
  • Greater than: >
  • Less than: <
  • Equals: :
  • Does not equal: !:
  • Includes: ~
  • Does not include: !~

Example – /report/groups?filter=name:Collector%20reports

Getting Details of Specific Report Group

URI: GET /report/groups/{id}

ParameterTypeDescription
idInteger(Mandatory) The Id of the report group that you want to get.
In This Article