Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.29 KB

maddash_api_intro.rst

File metadata and controls

32 lines (25 loc) · 1.29 KB
Raw

MaDDash API Reference

This page describes the Monitoring and Debugging Dashboard (MaDDash) API. The API uses a JSON data format and attempts to adhere closely to principles of REST. The interface provides access to the following types of resources:

  • Dashboard: A collection of one or more grid resources. The grouping of grids into a dashboard as defined by the creator of the dashboard resource.
  • Grid: A two-dimensional representation of one or more rows and columns of checks that measure some value between entities represented by the column value (x) and row value (y).
  • Check: The output of a task performed using the column value (x) and the row value (y) as input.
  • Column: A collection of checks that share a common x value.
  • Row: A collection of checks that share a common y value
  • Cell: A collection of checks that share a common x and y value

A visual representation of these resources is provided in the figure below:

images/maddash-resources.png

API Guide

.. toctree::
   :maxdepth: 2

   maddash_api_dashboards
   maddash_api_grids
   maddash_api_rows
   maddash_api_cells
   maddash_api_checks
   maddash_api_events
   maddash_api_reports
   maddash_api_type_params
   maddash_api_misc