Managing monthly reports with the API
Published on May 12, 2025 by Sean White
On the first of every month we generate an extensive PDF report for every site. This report contains a summary of all check results for the month and is a snapshot available to you and your team via email and the Oh Dear dashboard. We keep the report history so each month can be viewed in a browser or downloaded as a PDF.
This report can also be emailed to any email address - not just team members - perfect for keeping your customers informed.
Managing reports via API
Up until now you could enable this feature from the 'Monthly reports' menu within your site details dashboard where you can also find the history but you could not update these settings from the API.
We have been adding more and more support to our API recently including snoozing individual scheduled task and application health items, managing status pages, viewing sitemap reports as well as exposing all check settings.
We have now made it possible to create and update sites with send_report_to_emails and include_check_types_in_report parameters in the payload to control who receives an email and what appears on the report.
Here's an example where i'm updating your_site_id with just the new monthly report parameters
POST https://ohdear.app/api/sites/{your_site_id}
Payload
{ "send_report_to_emails": [ "[email protected]", "[email protected]", "[email protected]" ], "include_check_types_in_report": [ "uptime", "performance", "broken_links", "mixed_content", "lighthouse", "cron", "application_health", "sitemap", "dns", "domain", "certificate_health", "certificate_transparency" ] }
What's next?
Have you got any feature requests or anything you would like to see in the API that we haven't covered yet?
