The CheckCentral API provides an endpoint for adding reports programmatically. All of the configuration options are available through the API, detailed below. To add a new report through the API, you will require an API token for your organization with Read/Write access. Organization administrators can create tokens through the API portal on your dashboard.
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 Content-Type
header set to application/json
. 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:
The report data must include a name
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. The |
String | |
The type of the new report. The |
One of:
|
|
A text description of the report. The description will be included in the body of emails delivering the report. |
String/td> | |
The name for the new user. |
String | |
The output format for the report. Different report sources allow for different formats. |
One of:
|
For digest reports, the format will always be set to embedded . |
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. |
ReportContent | {} |
Parameter | Type/Allowed Values | Default |
---|---|---|
Pass a check ID to to use for the report. The String The |
||
Pass a checkgroup ID to use for the report. The |
String |
[] |
We're pleased to announce that we've added a number formatting setting. This allows you to change the way numbers are presented in your organization (i.e 10,000.12 or 10 000.12 or 10.000,12 or 10000.12).
As always, if you have any questions, please feel free to contact us for assistance!
We're pleased to announce that we've added External Emails as a notification channel for your CheckCentral notifications! To get started with it, login to your CheckCentral dashboard, then click Notifications > Organization. From there you can add it as a new channel, and detailed instructions are in the configuration window.
This channel allows notifications to be sent sent to an email address of a user outside of your orgainzation. By default "apply this channel to all checks" is enabled but it can be turned off and applied to specific check groups only.
As always, if you have any questions, please feel free to contact us for assistance!
We're pleased to announce that we've added Bugzilla as a notification channel for your CheckCentral notifications! To get started with it, login to your CheckCentral dashboard, then click Notifications > Organization. From there you can add it as a new channel, and detailed instructions are in the configuration window.
As always, if you have any questions, please feel free to contact us for assistance!
We're pleased to announce that we've added Redmine as a notification channel for your CheckCentral notifications! To get started with it, login to your CheckCentral dashboard, then click Notifications > Organization. From there you can add it as a new channel, and detailed instructions are in the configuration window.
As always, if you have any questions, please feel free to contact us for assistance!