The CheckCentral API provides an endpoint for programmatically adding reports.
To add a new report through the API, an API token with Read/Write access is required. Organization administrators can create tokens through the API portal on your dashboard.
"User API Tokens" will only return data available to the user based on their granted permissions and user groups. Regular "API Tokens" have the Access Level given upon creation.
The endpoint is located at
https://api.checkcentral.cc/createReport/?apiToken=APITOKEN
where the APITOKEN placeholder is replaced with your valid token.
The request must be made with the
header set to
. The body of the request should contain the properties below to configure the new report's settings. Any properties not passed will be set to their default value.
For example, to add a new report you could send the following json in the body of the request:
{
"name": "Dashboard Report",
"description": "",
"report_type": "Dashboard",
"format": "HTML",
"content": {
"dashboard": "d45deb0a-1752-4441-b822-52b88d7c7de1"
},
"interval_type": "Day",
"interval_value": 1,
"report_time": 540,
"recipients": {
"org_wide": true,
"usergroups": [],
"users": [],
"emails": [
"extra@example.com"
]
}
}
The report data must include a
property as well as any data required to generate the report such as check group IDs or dashboard IDs.
The complete list of possible properties for report creation are as follows:
| Parameter |
Type/Allowed Values |
Default |
|---|
|
The name of the new report.
This parameter is required. |
String |
|
|
The type of the new report.
This parameter is required. |
One of:
- dashboard
- checkgroup
- check
- activity
- stats
- digest
|
|
|
A text description of the report. The description will be included in the body of emails delivering the report. |
String |
|
|
The name for the new user. |
String |
|
|
The output format for the report. Different report sources allow for different formats. |
One of:
- html
- pdf
- csv (activity and stats only)
|
For digest reports, the format will always be set to . |
|
Set an optional filename to use for the report. Reports will be generated with a default filename that includes the date of the report and information such as the report type and content. |
String |
|
|
Pass a json object to configure what content CheckCentral will include in the report. |
Report Content |
|
The parameters below are nested elements for the
parameter above.
| Parameter |
Type/Allowed Values |
Default |
|---|
Pass a check ID to to use for the report. This parameter is valid for , , and reports. Only one or may be configured for activity and stats reports. This parameter is required for reports. |
String |
|
|
Pass a checkgroup ID to use for the report. This parameter is valid for , , and reports. Only one or may be configured for activity and stats reports.[/text] |
String |
|
A full list of API Methods are available via the API page under your CheckCentral organization.
Log in to your account. Click "Organization" from the main menu, then "API."
Here you'll see the list of Methods available, their permission requirements, their purpose, and the call limit per day.
Click on any of the Methods to see a testing area with parameter requirements and an example of usage. Populate the fields and click "Send Test Request" to see the JSON Response.
CheckCentral Monitoring consolidates and simplifies backup, system, and software email updates into a clean, graphical dashboard, bringing peace of mind to IT administrators of SMBs, Enterprises, and MSPs.
To learn more about CheckCentral, visit:
https://www.checkcentral.ccBinary Fortress has spent 17 years in pursuit of one goal: create software to make life easier. Our software ranges from display management and system enhancement utilities to monitoring tools and digital signage. IT administrators, professional gamers, coffee-shop owners, and MSPs all rely on Binary Fortress to make their days better, and their lives easier.
Copyright © 2007-2024 Binary Fortress Software, all rights reserved.
The Binary Fortress logo is a trademark of Binary Fortress Software.
The CheckCentral logo is a trademark of Binary Fortress Software.
Binary Fortress Software
1000 Innovation Drive, Suite 500
Kanata, Ontario, Canada
K2K3E7
https://www.binaryfortress.com
