public-roadmap icon indicating copy to clipboard operation
public-roadmap copied to clipboard

Generate PDF report, with graph visualizations

Open zswanson opened this issue 3 years ago • 4 comments

💡 For general support requests and bug reports, please go to checklyhq.com/support

Is your feature request related to a problem? Please describe. We would like to generate a report suitable for delivery to a customer as evidence that Checkly monitoring shows our APIs within SLA over a 30 day window. Checkly currently will create a report that meets our need but its html only, and we have to open all the visualizations, then generate a PDF from the browser.

Describe the solution you'd like We'd like to see the ability to have Checkly create a PDF automatically, using selected tags/filters and time period. Graphics for visualizations optionally included. Potentially using 'whitelabel' custom icons or company name on the header. If this could be automatically scheduled for generation that'd be great too.

Describe alternatives you've considered Current methodology we've discussed is manual action each month to generate the report in Checkly and print to pdf. That won't scale of course so we're also looking at writing some automation scripts that would login to checkly and handle all the browser interactions to create the report. While we are using prometheus internally to monitor these APIs, we were struggling with how to get that data into a presentable report format for the customer and it turned out that the Checkly report is 'visually satisfying' to the customer and gave them the information they wanted to assess that we met the SLA.

zswanson avatar Mar 11 '22 13:03 zswanson

@zswanson thanks for mentioning this. Just to summarize and to make sure I understand:

  • you are using the /reporting screen for this right now?
  • have you considered directly using or API with the /check-results endpoint?

tnolet avatar Mar 16 '22 17:03 tnolet

That's correct, using /reporting in the site and generating a pdf from the browser.

I wasn't aware of the /check-result api endpoint, however looking at the docs now I see that it is limited to a 6 hour window, so we'd have to iterate multiple times to get a 30 day view like we can get in the /reporting view of the website

zswanson avatar Mar 17 '22 14:03 zswanson

@zswanson just coming back to this one, we also have a /reporting API endpoint you can use. It easily gets the last 30 days. Check https://developers.checklyhq.com/reference/getv1reporting

  • it has a built in 'last30Days` window
  • it allows for tag filtering

Don't forget to add your account ID and API key if you want to take it for a spin on the API playground.

image

tnolet avatar Apr 13 '22 17:04 tnolet

Ah I see. I've now left the company where this was needed, but I'll refer my former colleagues to this.

zswanson avatar Apr 13 '22 20:04 zswanson