CheckCentral API Documentation: createReport Endpoint

Binary Fortress Software — Mon, 23 Aug 2021 19:07:56 GMT

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 check report you could send the following json in the body of the request:

Code
Copy
Select All

{
"name": "Test Check",
    "report_type": "Check",
    "format": "PDF",
    "content": {
    "check": "8ff951c2-7ea8-41ca-a094-6288d6afede6",
    },
    "interval_type": "Unscheduled",
    "recipients": {
    "org_wide": true
}

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:

Report Structure

Parameter	Type/Allowed Values	Default
`name` The name of the new report. The `name` parameter is required.	String
`report_type` The type of the new report. The `report_type` parameter is required.	One of: dashboard checkgroup check activity stats digest billing statushistory weeklystatus monthlystatus customstatus consecutiveissues
`description` A text description of the report. The description will be included in the body of emails delivering the report.	String
`format` 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 `embedded`.
`filename` 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
`timezone` To run this report in a different timezone than your organization's timezone, specify it by the standard name in English, e.g. `Eastern Standard Time`, `Central European Standard Time`, or `Central Pacific Standard Time`.	String
`interval_type` Configure the time interval used for sending this report. Unscheduled reports can be send on-demand from your reports page.	One of: day week month unscheduled	`day`
`interval_value` How many days/weeks/months should elapse between schedule report deliveries.	Integer	`1`
`report_time` The time of day to send the report, in minutes past midnight. For example, 9am local time would be 540 for `9 * 60 minutes`.	Integer	`540`
`daily_report_days` Pass an array of days to indicate which days of the week this report should run. This option is only valid for reports with an `interval_type` of `day`.	An array containing either `"all"`, or any of: sun mon tue wed thu fri sat	`[ "all" ]`
`report_day` The day of the week to send the report. This option is only valid for reports with an `interval_type` of `week`.	One of: sun mon tue wed thu fri sat	`mon`
`report_day` The day of the month to send the report. This option is only valid for reports with an `interval_type` of `month`.		`1`
`content` Pass a json object to configure what content CheckCentral will include in this report.	ReportContent	`{}`
`recipients` Pass a json object to configure what recipients CheckCentral will send this report to.	ReportRecipients	`{}`

ReportContent

Parameter	Type/Allowed Values	Default
`dark_mode` Set this parameter render this report in dark mode (light text on dark background).	Bool	`false`
`use_name_as_title` Set this parameter to use this report's configured name as the document title when generating the report.	Bool	`false`
`check` Pass a check ID to to use for the report. The `check` parameter is valid for `activity`, `check`, and `stats` reports. Only one of `check` and `checkgroup` may be configured for activity and stats reports. String The `check` parameter is required for `check` reports.
`checkgroup` Pass a checkgroup ID to use for the report. The `checkgroup` parameter is valid for activity, check group, and stats reports. Only one of `check` and `checkgroup` may be configured for activity and stats reports.	String	`[]`

ReportRecipients

Parameter	Type/Allowed Values	Default
`org_wide` Pass this parameter to configure this report to be sent to all users in your organization.	Bool	`false`
`users` Pass an array of user IDs to send this report to. User IDs can be retrieved with the `getUsers` API endpoint. This parameter will be overridden by the `org_wide` setting.	[String]	`[]`
`usergroups` Pass an array of user group IDs to send this report to. User group IDs can be retrieved with the `getUserGroups` API endpoint. This parameter will be overridden by the `org_wide` setting.	Array[String]	`[]`
`all_channels` Pass this parameter to configure this report to be sent to all users in your organization.	Bool	`false`
`channels` Pass an array of notification channel IDs to send this report to. IDs can be retrieved with the `getNotificationChannels` API endpoint. This parameter will be overridden by the `all_channels` setting.	[String]	`[]`
`emails` Pass an array of email addresses for people outside your organzation to send this report to. Reports sent to external emails will contain all configured checks and groups.	[String]	`[]`

CheckCentral RSS: CheckCentral API Documentation: createReport Endpoint

CheckCentral API Documentation: createReport Endpoint

CodeCopySelect All

Report Structure

ReportContent

ReportRecipients

Code
Copy
Select All