7.2.1. HTTP JSON API

The Dashboard API provides non-interactive access to the Dashboard’s analysis data. This can be used to automate various tasks, such as:

  • Creating and archiving custom violation reports

  • Creating and sending custom notification emails

  • Exporting data for use with other tools

The Dashboard API is an HTTP API. While it offers different output format options in some cases, the primary response and error format is JSON.

You can access the API via webhooks or using the programming language of your choice. Most programming languages provide an HTTP client library and a convenient way to parse JSON data, making the API straightforward to use. Before using this API directly from Python, consider using our Python API wrapper.