github.com/GoogleCloudPlatform/testgrid@v0.0.174/pkg/api/README.md (about)

     1  # TestGrid HTTP API
     2  Valid responses are all in JSON. Error responses may not be in JSON. Replace things in curly braces.
     3  
     4  Exact API definitions can be found on [GitHub](https://github.com/GoogleCloudPlatform/testgrid/blob/master/pb/api/v1/data.proto).
     5  
     6  ## LIST
     7  "List" methods use the GET HTTP verb. See https://cloud.google.com/apis/design/standard_methods for details.
     8  
     9  - /api/v1/dashboards - List dashboards
    10  - /api/v1/dashboard-groups - List dashboard groups
    11  - /api/v1/dashboards/{dashboard}/tabs - List a dashboard's tabs
    12  - /api/v1/dashboard-groups/{dashboard-group} - List the dashboards in a dashboard group
    13  - /api/v1/dashboards/{dashboard}/tab-summaries - List the tab summaries for the dashboard (data rendered in dashboard view)
    14  - /api/v1/dashboard-groups/{dashboard-group}/dashboard-summaries - List the dashboard summaries for the dashboard group (data rendered in dashboard group view)
    15  
    16  ## GET
    17  - /api/v1/dashboards/{dashboard} - Returns a dashboard's configuration. Often empty; dashboard-level configuration is rare.
    18  - /api/v1/dashboards/{dashboard}/tabs/{tab}/headers - Returns the headers for a tab's grid result
    19  - /api/v1/dashboards/{dashboard}/tabs/{tab}/rows - Returns information on a tab's rows and the data within those rows.
    20  - /api/v1/dashboards/{dashboard}/tab-summaries/{tab} - Returns the summary for a particular tab in the given dashboard
    21  - /api/v1/dashboards/{dashboard}/summary - Returns the aggregated summary for a particular dashboard.