Add a Report
Last updated - 23 July, 2025
In this article
- Property
- Description
- Required?
- Type
- Example
- Alerts Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Alert SLA Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Alert Threshold Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Alert Trends Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Device Inventory Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Device Metric Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Interface Bandwidth Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Netflow Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Server CPU Report Parameters
- Property
- Description
- Required?
- Type
- Example
- SLA Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Website Service Overview Report Parameters
- Property
- Description
- Required?
- Type
- Example
- Examples
- Example Request 1: Add an Alert Report
- Example Request 2: Alert SLA Report
- Example Request 3: Alert Threshold Report
- Example Request 4: Alert Trends Report
- Example Request 5: Device Inventory Report
- Example Request 6: Device Metric Trends Report
- Example Request 7: Interface Bandwidth Report
- Example Request 8: Netflow Report
- Example Request 9: Server CPU Report
- Example Request 10: SLA Report
- Example Request 11: Website Service Overview Report
- Example Response
With LogicMonitor’s REST API you can programmatically add a new report definition to your LogicMonitor account. If you are looking for information on how to run a report, see this page instead.
As with all of our API calls, authentication is required.
Note that the following report types are not being released now, but are expected to be released in the next release or two:
- Audit Log Report
- Alert Forecasting Report
HTTP Method: POST
URI: /report/reports
You may POST the following parameters in your request:
Alerts Report Parameters
You must additionally POST the following parameters for all reports of type Alert:
Alert SLA Report Parameters
You must additionally POST the following parameters for all reports of type Alert SLA:
Alert Threshold Report Parameters
You must additionally POST the following parameters for all reports of type Alert threshold:
Alert Trends Report Parameters
You must additionally POST the following parameters for all reports of type Alert trends:
Device Inventory Report Parameters
You must additionally POST the following parameters for all reports of type Host inventory:
Device Metric Report Parameters
You must additionally POST the following parameters for all reports of type Host metric trends:
Interface Bandwidth Report Parameters
You must additionally POST the following parameters for all reports of type Interfaces Bandwidth:
Netflow Report Parameters
You must additionally POST the following parameters for all reports of type Netflow device metric:
Server CPU Report Parameters
You must additionally POST the following parameters for all reports of type Host CPU:
SLA Report Parameters
You must additionally POST the following parameters for all reports of type Service Level Agreement:
Website Service Overview Report Parameters
You must additionally POST the following parameters for all reports of type Website Service Overview:
Examples
The following examples illustrate adding various Reports to the account api.logicmonitor com:
- Example Request 1 – Add an Alert Report
- Example Request 2 – Add an Alert SLA Report
- Example Request 3 – Add an Alert Threshold Report
- Example Request 4 – Add an Alert Trends Report
- Example Request 5 – Add a Device Inventory Report
- Example Request 6 – Add a Device Metric Trends Report
- Example Request 7 – Add an Interface Bandwidth Report
- Example Request 8 – Add a Netflow Report
- Example Request 9 – Add a Server CPU Report
- Example Request 10 – Add an SLA Report
- Example Request 11 – Add a Website Service Overview Report
- Example Response
Example Request 1: Add an Alert Report
The following Python 3 script will add an Alert report to api.logicmonitor.com:
Example Request 2: Alert SLA Report
The following Python 3 script will add an Alert SLA report to api.logicmonitor.com:
Example Request 3: Alert Threshold Report
The following Python 3 script will add an Alert Threshold report to api.logicmonitor.com:
Example Request 4: Alert Trends Report
The following Python 3 script will add an Alert Trends report to api.logicmonitor.com:
Example Request 5: Device Inventory Report
The following Python 3 script will add a Device Inventory report to api.logicmonitor.com:
Example Request 6: Device Metric Trends Report
The following Python 3 script will add a Device Metric Trends report to api.logicmonitor.com:
Example Request 7: Interface Bandwidth Report
The following Python 3 script will add an Interface Bandwidth report to api.logicmonitor.com:
Example Request 8: Netflow Report
The following Python 3 script will add a Netflow report to api.logicmonitor.com:
Example Request 9: Server CPU Report
The following Python 3 script will add a Server CPU report to api.logicmonitor.com:
Example Request 10: SLA Report
The following Python 3 script will add an SLA report to api.logicmonitor.com:
Example Request 11: Website Service Overview Report
The following Python 3 script will add a Website Service Overview report to api.logicmonitor.com
Example Response
The following is an example response for one of the above example requests: