CheckCentral API Documentation: createReport Endpoint

WARNING: You currently have Javascript disabled!
This website will not function correctly without Javascript enabled.

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:

Code
Copy
Select All

{
  "name": "Some Report",
  "email": "person@myorg.realdomain",
  "accessLevel": "User",
  "sendWelcomeEmail": true,
  "userGroups": [
    "userGroupID"
  ],
  "notifications": [
    { 
        "type": "failures",
        "services": [
            "sms",
            "push"
        ]
    }
  ]
}

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
`description` A text description of the report. The description will be included in the body of emails delivering the report.	String/td>
`source` The name for the new user.	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
`content` Pass a json object to configure what content CheckCentral will include in the report.	ReportContent	`{}`

ReportContent

Parameter Type/Allowed Values Default

Parameter	Type/Allowed Values	Default
`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	`[]`

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

[]

Aug 23, 2021 (modified May 31, 2022) • #1

Was this helpful?

(-)